@katanaperps/katana-perps-sdk 0.0.0-placeholder

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

@@ -0,0 +1,131 @@
+import type { MessageEventType } from '#types/enums/index';
+import type { KatanaPerpsTicker } from '#types/rest/endpoints/GetTickers';
+import type { KatanaPerpsSubscriptionEventBase } from '#types/webSocket/base';
+/**
+ * When the `tickers` subscription provides an update
+ *
+ * @category WebSocket - Message Types
+ * @category KatanaPerps - Get Tickers
+ */
+export interface KatanaPerpsTickerEvent extends KatanaPerpsSubscriptionEventBase {
+    /**
+     * @inheritDoc
+     */
+    type: typeof MessageEventType.tickers;
+    /**
+     * @inheritDoc KatanaPerpsOrderFillEventData
+     *
+     * @see type {@link KatanaPerpsTickerEventData}
+     */
+    data: KatanaPerpsTickerEventData;
+}
+/**
+ * Represents the type found on the {@link KatanaPerpsTickerEvent.data} property.
+ *
+ * - An alias of the {@link KatanaPerpsTicker} interface.
+ *
+ * @see parent {@link KatanaPerpsTickerEvent}
+ *
+ * @category WebSocket - Message Types
+ */
+export type KatanaPerpsTickerEventData = KatanaPerpsTicker;
+export interface WebSocketResponseSubscriptionMessageShortTickers extends KatanaPerpsSubscriptionEventBase {
+    type: typeof MessageEventType.tickers;
+    data: WebSocketResponseTickerShort;
+}
+/**
+ * @internal
+ *
+ * Ticker response from the WebSocket, which is a deflated version of {@link RestResponseTicker}
+ */
+export interface WebSocketResponseTickerShort {
+    /**
+     * @see inflated {@link RestResponseTicker.market}
+     */
+    m: KatanaPerpsTickerEventData['market'];
+    /**
+     * @see inflated {@link RestResponseTicker.time}
+     */
+    t: KatanaPerpsTickerEventData['time'];
+    /**
+     * @see inflated {@link RestResponseTicker.open}
+     */
+    o: KatanaPerpsTickerEventData['open'];
+    /**
+     * @see inflated {@link RestResponseTicker.high}
+     */
+    h: KatanaPerpsTickerEventData['high'];
+    /**
+     * @see inflated {@link RestResponseTicker.low}
+     */
+    l: KatanaPerpsTickerEventData['low'];
+    /**
+     * @see inflated {@link RestResponseTicker.close}
+     */
+    c: KatanaPerpsTickerEventData['close'];
+    /**
+     * @see inflated {@link RestResponseTicker.closeQuantity}
+     */
+    Q: KatanaPerpsTickerEventData['closeQuantity'];
+    /**
+     * @see inflated {@link RestResponseTicker.baseVolume}
+     */
+    v: KatanaPerpsTickerEventData['baseVolume'];
+    /**
+     * @see inflated {@link RestResponseTicker.quoteVolume}
+     */
+    q: KatanaPerpsTickerEventData['quoteVolume'];
+    /**
+     * @see inflated {@link RestResponseTicker.percentChange}
+     */
+    P: KatanaPerpsTickerEventData['percentChange'];
+    /**
+     * @see inflated {@link RestResponseTicker.trades}
+     */
+    n: KatanaPerpsTickerEventData['trades'];
+    /**
+     * @see inflated {@link RestResponseTicker.ask}
+     */
+    a: KatanaPerpsTickerEventData['ask'];
+    /**
+     * @see inflated {@link RestResponseTicker.bid}
+     */
+    b: KatanaPerpsTickerEventData['bid'];
+    /**
+     * @see inflated {@link RestResponseTicker.markPrice}
+     */
+    mp: KatanaPerpsTickerEventData['markPrice'];
+    /**
+     * @see inflated {@link RestResponseTicker.indexPrice}
+     */
+    ip: KatanaPerpsTickerEventData['indexPrice'];
+    /**
+     * @see inflated {@link RestResponseTicker.indexPrice24h}
+     */
+    id: KatanaPerpsTickerEventData['indexPrice24h'];
+    /**
+     * @see inflated {@link RestResponseTicker.indexPricePercentChange}
+     */
+    iP: KatanaPerpsTickerEventData['indexPricePercentChange'];
+    /**
+     * @see inflated {@link RestResponseTicker.lastFundingRate}
+     */
+    lf: KatanaPerpsTickerEventData['lastFundingRate'];
+    /**
+     * @see inflated {@link RestResponseTicker.currentFundingRate}
+     */
+    nf: KatanaPerpsTickerEventData['currentFundingRate'];
+    /**
+     * @see inflated {@link RestResponseTicker.nextFundingTime}
+     */
+    ft: KatanaPerpsTickerEventData['nextFundingTime'];
+    /**
+     * @see inflated {@link RestResponseTicker.openInterest}
+     */
+    oi: KatanaPerpsTickerEventData['openInterest'];
+    /**
+     * @see inflated {@link RestResponseTicker.sequence}
+     */
+    u: KatanaPerpsTickerEventData['sequence'];
+}
+//# sourceMappingURL=tickers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tickers.d.ts","sourceRoot":"","sources":["../../../../src/types/webSocket/response/tickers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAC;AAC9E;;;;;GAKG;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;;;;;;;;GAQG;AACH,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,CAAC;AAE3D,MAAM,WAAW,gDACf,SAAQ,gCAAgC;IACxC,IAAI,EAAE,OAAO,gBAAgB,CAAC,OAAO,CAAC;IACtC,IAAI,EAAE,4BAA4B,CAAC;CACpC;AAED;;;;GAIG;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,MAAM,CAAC,CAAC;IACtC;;OAEG;IACH,CAAC,EAAE,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACtC;;OAEG;IACH,CAAC,EAAE,0BAA0B,CAAC,KAAK,CAAC,CAAC;IACrC;;OAEG;IACH,CAAC,EAAE,0BAA0B,CAAC,OAAO,CAAC,CAAC;IACvC;;OAEG;IACH,CAAC,EAAE,0BAA0B,CAAC,eAAe,CAAC,CAAC;IAC/C;;OAEG;IACH,CAAC,EAAE,0BAA0B,CAAC,YAAY,CAAC,CAAC;IAC5C;;OAEG;IACH,CAAC,EAAE,0BAA0B,CAAC,aAAa,CAAC,CAAC;IAC7C;;OAEG;IACH,CAAC,EAAE,0BAA0B,CAAC,eAAe,CAAC,CAAC;IAC/C;;OAEG;IACH,CAAC,EAAE,0BAA0B,CAAC,QAAQ,CAAC,CAAC;IACxC;;OAEG;IACH,CAAC,EAAE,0BAA0B,CAAC,KAAK,CAAC,CAAC;IACrC;;OAEG;IACH,CAAC,EAAE,0BAA0B,CAAC,KAAK,CAAC,CAAC;IACrC;;OAEG;IACH,EAAE,EAAE,0BAA0B,CAAC,WAAW,CAAC,CAAC;IAC5C;;OAEG;IACH,EAAE,EAAE,0BAA0B,CAAC,YAAY,CAAC,CAAC;IAC7C;;OAEG;IACH,EAAE,EAAE,0BAA0B,CAAC,eAAe,CAAC,CAAC;IAChD;;OAEG;IACH,EAAE,EAAE,0BAA0B,CAAC,yBAAyB,CAAC,CAAC;IAC1D;;OAEG;IACH,EAAE,EAAE,0BAA0B,CAAC,iBAAiB,CAAC,CAAC;IAClD;;OAEG;IACH,EAAE,EAAE,0BAA0B,CAAC,oBAAoB,CAAC,CAAC;IACrD;;OAEG;IACH,EAAE,EAAE,0BAA0B,CAAC,iBAAiB,CAAC,CAAC;IAClD;;OAEG;IACH,EAAE,EAAE,0BAA0B,CAAC,cAAc,CAAC,CAAC;IAE/C;;OAEG;IACH,CAAC,EAAE,0BAA0B,CAAC,UAAU,CAAC,CAAC;CAC3C"}

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

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

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

@@ -0,0 +1,90 @@
+import type { MessageEventType } from '#types/enums/index';
+import type { KatanaPerpsTrade } from '#types/rest/endpoints/GetTrades';
+import type { KatanaPerpsSubscriptionEventBase } from '#types/webSocket/base';
+/**
+ * When the `trades` subscription provides an update
+ *
+ * @category KatanaPerps - Get Trades
+ * @category WebSocket - Message Types
+ */
+export interface KatanaPerpsTradeEvent extends KatanaPerpsSubscriptionEventBase {
+    /**
+     * @inheritDoc
+     */
+    type: typeof MessageEventType.trades;
+    /**
+     * @inheritDoc KatanaPerpsTradeEventData
+     *
+     * @see type {@link KatanaPerpsTradeEventData}
+     */
+    data: KatanaPerpsTradeEventData;
+}
+/**
+ * - Trade updates on the WebSocket include all {@link KatanaPerpsTrade} properties as well
+ *   as the `market` symbol that corresponds to the trade.
+ *
+ * @see related {@link KatanaPerpsTrade}
+ *
+ * @category KatanaPerps - Get Trades
+ * @category WebSocket - Message Types
+ */
+export interface KatanaPerpsTradeEventData extends KatanaPerpsTrade {
+    /**
+     * Market Symbol
+     */
+    market: string;
+}
+export interface WebSocketResponseSubscriptionMessageShortTrades extends KatanaPerpsSubscriptionEventBase {
+    type: typeof MessageEventType.trades;
+    data: WebSocketResponseTradeShort;
+}
+/**
+ * @internal
+ *
+ * WebSocket Response Trade - Short (Deflated)
+ *
+ * An extended version used by WebSocket of {@link RestResponseTrade}
+ */
+export interface WebSocketResponseTradeShort {
+    /**
+     * @see inflated {@link KatanaPerpsTradeEventData.market}
+     */
+    m: KatanaPerpsTradeEventData['market'];
+    /**
+     * @see related {@link RestResponseTrade.fillId}
+     * @see inflated {@link KatanaPerpsTradeEventData.fillId}
+     */
+    i: KatanaPerpsTradeEventData['fillId'];
+    /**
+     * @see related {@link RestResponseTrade.price}
+     * @see inflated {@link KatanaPerpsTradeEventData.price}
+     */
+    p: KatanaPerpsTradeEventData['price'];
+    /**
+     * @see related {@link RestResponseTrade.quantity}
+     * @see inflated {@link KatanaPerpsTradeEventData.quantity}
+     */
+    q: KatanaPerpsTradeEventData['quantity'];
+    /**
+     * @see related {@link RestResponseTrade.quoteQuantity}
+     * @see inflated {@link KatanaPerpsTradeEventData.quoteQuantity}
+     */
+    Q: KatanaPerpsTradeEventData['quoteQuantity'];
+    /**
+     * @see related {@link RestResponseTrade.time}
+     * @see inflated {@link KatanaPerpsTradeEventData.time}
+     */
+    t: KatanaPerpsTradeEventData['time'];
+    /**
+     * @see enum {@link enums2.OrderSide}
+     * @see related {@link RestResponseTrade.makerSide}
+     * @see inflated {@link KatanaPerpsTradeEventData.makerSide}
+     */
+    s: KatanaPerpsTradeEventData['makerSide'];
+    /**
+     * @see related {@link RestResponseTrade.sequence}
+     * @see inflated {@link KatanaPerpsTradeEventData.sequence}
+     */
+    u: KatanaPerpsTradeEventData['sequence'];
+}
+//# sourceMappingURL=trades.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"trades.d.ts","sourceRoot":"","sources":["../../../../src/types/webSocket/response/trades.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAC;AAE9E;;;;;GAKG;AACH,MAAM,WAAW,qBACf,SAAQ,gCAAgC;IACxC;;OAEG;IACH,IAAI,EAAE,OAAO,gBAAgB,CAAC,MAAM,CAAC;IACrC;;;;OAIG;IACH,IAAI,EAAE,yBAAyB,CAAC;CACjC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IACjE;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,+CACf,SAAQ,gCAAgC;IACxC,IAAI,EAAE,OAAO,gBAAgB,CAAC,MAAM,CAAC;IACrC,IAAI,EAAE,2BAA2B,CAAC;CACnC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,CAAC,EAAE,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IACvC;;;OAGG;IACH,CAAC,EAAE,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IACvC;;;OAGG;IACH,CAAC,EAAE,yBAAyB,CAAC,OAAO,CAAC,CAAC;IACtC;;;OAGG;IACH,CAAC,EAAE,yBAAyB,CAAC,UAAU,CAAC,CAAC;IACzC;;;OAGG;IACH,CAAC,EAAE,yBAAyB,CAAC,eAAe,CAAC,CAAC;IAC9C;;;OAGG;IACH,CAAC,EAAE,yBAAyB,CAAC,MAAM,CAAC,CAAC;IACrC;;;;OAIG;IACH,CAAC,EAAE,yBAAyB,CAAC,WAAW,CAAC,CAAC;IAC1C;;;OAGG;IACH,CAAC,EAAE,yBAAyB,CAAC,UAAU,CAAC,CAAC;CAC1C"}

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

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

package/dist/types/webSocket/response/webclient/base.d.ts

@@ -0,0 +1,24 @@
+import type { WebClientEvent } from '#types/enums/index';
+import type { AnyObj } from '#types/utils';
+export interface KatanaPerpsWebClientEventDataBase {
+    /**
+     * When provided, use the value to narrow the shape of {@link action}
+     */
+    readonly event: WebClientEvent;
+    /**
+     * When provided, use to narrow the shape of {@link payload}
+     */
+    readonly action?: string;
+    /**
+     * The wallet address to dispatch the event to if provided.
+     *
+     * - When not given, indicates the event was dispatched as a broadcast or through
+     *   some other filter.
+     */
+    readonly wallet?: string;
+    /**
+     * The shape of `payload` is dependent upon the {@link event} and {@link action} properties value(s).
+     */
+    readonly payload?: AnyObj;
+}
+//# sourceMappingURL=base.d.ts.map

package/dist/types/webSocket/response/webclient/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../../../src/types/webSocket/response/webclient/base.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAE3C,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAC/B;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B"}

package/dist/types/webSocket/response/webclient/base.js

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

package/dist/types/webSocket/response/webclient/events/exchangeStatus.d.ts

@@ -0,0 +1,31 @@
+import type { WebClientEvent, WebClientEventExchangeStatusAction } from '#types/enums/index';
+import type { AnyObj } from '#types/utils';
+import type { KatanaPerpsWebClientEventDataBase } from '../base.js';
+interface KatanaPerpsWebClientEventDataExchangeStatusBase extends KatanaPerpsWebClientEventDataBase {
+    readonly event: typeof WebClientEvent.exchange_status_updated;
+    /**
+     * @see enum {@link WebClientEventExchangeStatusAction}
+     */
+    readonly action: WebClientEventExchangeStatusAction;
+    readonly payload?: AnyObj;
+}
+export interface KatanaPerpsWebClientEventDataExchangeStatusExchange extends KatanaPerpsWebClientEventDataExchangeStatusBase {
+    readonly action: typeof WebClientEventExchangeStatusAction.controls_exchange;
+    readonly wallet?: undefined;
+    readonly payload?: undefined;
+}
+export interface KatanaPerpsWebClientEventDataExchangeStatusMarket extends KatanaPerpsWebClientEventDataExchangeStatusBase {
+    readonly action: typeof WebClientEventExchangeStatusAction.controls_market;
+    readonly wallet?: undefined;
+    readonly payload: {
+        market: string;
+    };
+}
+export interface KatanaPerpsWebClientEventDataExchangeStatusWallet extends KatanaPerpsWebClientEventDataExchangeStatusBase {
+    readonly action: typeof WebClientEventExchangeStatusAction.controls_wallet;
+    readonly wallet: string;
+    readonly payload?: undefined;
+}
+export type KatanaPerpsWebClientEventDataExchangeStatus = KatanaPerpsWebClientEventDataExchangeStatusExchange | KatanaPerpsWebClientEventDataExchangeStatusMarket | KatanaPerpsWebClientEventDataExchangeStatusWallet;
+export {};
+//# sourceMappingURL=exchangeStatus.d.ts.map

package/dist/types/webSocket/response/webclient/events/exchangeStatus.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exchangeStatus.d.ts","sourceRoot":"","sources":["../../../../../../src/types/webSocket/response/webclient/events/exchangeStatus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,kCAAkC,EACnC,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,YAAY,CAAC;AAEpE,UAAU,+CACR,SAAQ,iCAAiC;IACzC,QAAQ,CAAC,KAAK,EAAE,OAAO,cAAc,CAAC,uBAAuB,CAAC;IAC9D;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,kCAAkC,CAAC;IACpD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,mDACf,SAAQ,+CAA+C;IACvD,QAAQ,CAAC,MAAM,EAAE,OAAO,kCAAkC,CAAC,iBAAiB,CAAC;IAC7E,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC;CAC9B;AAED,MAAM,WAAW,iDACf,SAAQ,+CAA+C;IACvD,QAAQ,CAAC,MAAM,EAAE,OAAO,kCAAkC,CAAC,eAAe,CAAC;IAC3E,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE;QAChB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,iDACf,SAAQ,+CAA+C;IACvD,QAAQ,CAAC,MAAM,EAAE,OAAO,kCAAkC,CAAC,eAAe,CAAC;IAC3E,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC;CAC9B;AAED,MAAM,MAAM,2CAA2C,GACnD,mDAAmD,GACnD,iDAAiD,GACjD,iDAAiD,CAAC"}

package/dist/types/webSocket/response/webclient/events/exchangeStatus.js

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

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

@@ -0,0 +1,4 @@
+export * from './reloadBanners.js';
+export * from './exchangeStatus.js';
+export * from './transactionSettled.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/types/webSocket/response/webclient/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC"}

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

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./reloadBanners.js"), exports);
+tslib_1.__exportStar(require("./exchangeStatus.js"), exports);
+tslib_1.__exportStar(require("./transactionSettled.js"), exports);

package/dist/types/webSocket/response/webclient/events/reloadBanners.d.ts

@@ -0,0 +1,17 @@
+import type { WebClientEvent } from '#types/enums/index';
+import type { KatanaPerpsWebClientEventDataBase } from '../base.js';
+type NoticeArea = 'notification' | 'banner';
+export interface KatanaPerpsWebClientEventDataReloadBanners extends KatanaPerpsWebClientEventDataBase {
+    readonly event: typeof WebClientEvent.reload_banners;
+    readonly action: NoticeArea;
+    wallet?: undefined;
+    readonly payload: {
+        change: 'add' | 'remove';
+        /**
+         * The id of the notice that was added or removed
+         */
+        id: string;
+    };
+}
+export {};
+//# sourceMappingURL=reloadBanners.d.ts.map

package/dist/types/webSocket/response/webclient/events/reloadBanners.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reloadBanners.d.ts","sourceRoot":"","sources":["../../../../../../src/types/webSocket/response/webclient/events/reloadBanners.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,YAAY,CAAC;AAEpE,KAAK,UAAU,GAAG,cAAc,GAAG,QAAQ,CAAC;AAE5C,MAAM,WAAW,0CACf,SAAQ,iCAAiC;IACzC,QAAQ,CAAC,KAAK,EAAE,OAAO,cAAc,CAAC,cAAc,CAAC;IACrD,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,QAAQ,CAAC,OAAO,EAAE;QAChB,MAAM,EAAE,KAAK,GAAG,QAAQ,CAAC;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ,CAAC;CACH"}

package/dist/types/webSocket/response/webclient/events/reloadBanners.js

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

package/dist/types/webSocket/response/webclient/events/transactionSettled.d.ts

@@ -0,0 +1,76 @@
+import type { PayoutProgram, WebClientEvent, WebClientEventTxSettledAction } from '#types/enums/index';
+import type { AnyObj } from '#types/utils';
+import type { KatanaPerpsWebClientEventDataBase } from '../base.js';
+interface KatanaPerpsWebClientEventDataTxSettledBase extends KatanaPerpsWebClientEventDataBase {
+    /**
+     * @inheritDoc
+     */
+    readonly event: typeof WebClientEvent.transaction_settled;
+    /**
+     * @inheritDoc
+     */
+    readonly wallet: string;
+    /**
+     * @inheritDoc
+     */
+    readonly action?: WebClientEventTxSettledAction;
+    /**
+     * @inheritDoc
+     */
+    readonly payload: AnyObj;
+}
+export interface KatanaPerpsWebClientEventDataTxSettledPayout extends KatanaPerpsWebClientEventDataTxSettledBase {
+    /**
+     * @inheritDoc
+     */
+    readonly action: typeof WebClientEventTxSettledAction.payout;
+    /**
+     * @inheritDoc
+     */
+    readonly payload: {
+        /**
+         * - Will be deprecated in future release
+         */
+        payoutProgramId: number;
+        /**
+         * @see enum {@link PayoutProgram}
+         */
+        program: PayoutProgram;
+        asset: 'USDC' | 'iBGT';
+        amountPaid: string;
+        nonce: string;
+        txHash: string;
+    };
+}
+export interface KatanaPerpsWebClientEventDataTxSettledWithdraw extends KatanaPerpsWebClientEventDataTxSettledBase {
+    /**
+     * @inheritDoc
+     */
+    readonly action: typeof WebClientEventTxSettledAction.withdraw;
+    /**
+     * @inheritDoc
+     */
+    readonly payload: {
+        withdrawalId: string | null;
+        asset: 'USDC';
+        txHash: string;
+    };
+}
+export interface KatanaPerpsWebClientEventDataTxSettledExecuteTrade extends KatanaPerpsWebClientEventDataTxSettledBase {
+    /**
+     * @inheritDoc
+     */
+    readonly action: typeof WebClientEventTxSettledAction.executeTrade;
+    /**
+     * @inheritDoc
+     */
+    readonly payload: {
+        fillId: string;
+        orderId: string;
+        market: string;
+        txHash: string;
+    };
+}
+export type KatanaPerpsWebClientEventDataTxSettled = KatanaPerpsWebClientEventDataTxSettledPayout | KatanaPerpsWebClientEventDataTxSettledWithdraw | KatanaPerpsWebClientEventDataTxSettledExecuteTrade;
+export {};
+//# sourceMappingURL=transactionSettled.d.ts.map

package/dist/types/webSocket/response/webclient/events/transactionSettled.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionSettled.d.ts","sourceRoot":"","sources":["../../../../../../src/types/webSocket/response/webclient/events/transactionSettled.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,6BAA6B,EAC9B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,YAAY,CAAC;AAEpE,UAAU,0CACR,SAAQ,iCAAiC;IACzC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,cAAc,CAAC,mBAAmB,CAAC;IAC1D;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,6BAA6B,CAAC;IAChD;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,4CACf,SAAQ,0CAA0C;IAClD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,6BAA6B,CAAC,MAAM,CAAC;IAC7D;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE;QAChB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QACxB;;WAEG;QACH,OAAO,EAAE,aAAa,CAAC;QACvB,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;QACvB,UAAU,EAAE,MAAM,CAAC;QACnB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,8CACf,SAAQ,0CAA0C;IAClD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,6BAA6B,CAAC,QAAQ,CAAC;IAC/D;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE;QAChB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,kDACf,SAAQ,0CAA0C;IAClD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,6BAA6B,CAAC,YAAY,CAAC;IACnE;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,MAAM,sCAAsC,GAC9C,4CAA4C,GAC5C,8CAA8C,GAC9C,kDAAkD,CAAC"}

package/dist/types/webSocket/response/webclient/events/transactionSettled.js

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

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

@@ -0,0 +1,3 @@
+export * from './events/index.js';
+export * from './webclient.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/types/webSocket/response/webclient/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC"}

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

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./events/index.js"), exports);
+tslib_1.__exportStar(require("./webclient.js"), exports);

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

@@ -0,0 +1,13 @@
+import type { MessageEventType } from '#types/enums/index';
+import type { KatanaPerpsSubscriptionEventBase } from '#types/webSocket/base';
+import type { KatanaPerpsWebClientEventDataReloadBanners, KatanaPerpsWebClientEventDataExchangeStatus, KatanaPerpsWebClientEventDataTxSettled } from './events/index.js';
+export type KatanaPerpsWebClientEventData = KatanaPerpsWebClientEventDataReloadBanners | KatanaPerpsWebClientEventDataExchangeStatus | KatanaPerpsWebClientEventDataTxSettled;
+export interface KatanaPerpsWebClientEvent extends KatanaPerpsSubscriptionEventBase {
+    /**
+     * @inheritDoc
+     */
+    readonly type: typeof MessageEventType.webclient;
+    readonly data: KatanaPerpsWebClientEventData;
+}
+export type WebSocketResponseSubscriptionMessageShortWebClient = KatanaPerpsWebClientEvent;
+//# sourceMappingURL=webclient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"webclient.d.ts","sourceRoot":"","sources":["../../../../../src/types/webSocket/response/webclient/webclient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAC;AAC9E,OAAO,KAAK,EACV,0CAA0C,EAC1C,2CAA2C,EAC3C,sCAAsC,EACvC,MAAM,mBAAmB,CAAC;AAE3B,MAAM,MAAM,6BAA6B,GACrC,0CAA0C,GAC1C,2CAA2C,GAC3C,sCAAsC,CAAC;AAE3C,MAAM,WAAW,yBACf,SAAQ,gCAAgC;IACxC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,gBAAgB,CAAC,SAAS,CAAC;IACjD,QAAQ,CAAC,IAAI,EAAE,6BAA6B,CAAC;CAC9C;AAED,MAAM,MAAM,kDAAkD,GAC5D,yBAAyB,CAAC"}

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

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

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

@@ -0,0 +1,83 @@
+import type { MessageEventType } from '#types/enums/index';
+import type { KatanaPerpsWithdrawal } from '#types/rest/endpoints/GetWithdrawals';
+import type { KatanaPerpsSubscriptionEventBase } from '#types/webSocket/base';
+/**
+ * When the `withdrawals` subscription provides an update
+ *
+ * @category WebSocket - Message Types
+ * @category KatanaPerps - Get Withdrawals
+ */
+export interface KatanaPerpsWithdrawalEvent extends KatanaPerpsSubscriptionEventBase {
+    /**
+     * @inheritDoc
+     */
+    type: typeof MessageEventType.withdrawals;
+    /**
+     * @inheritDoc KatanaPerpsWithdrawalEventData
+     *
+     * @see type {@link KatanaPerpsWithdrawalEventData}
+     */
+    data: KatanaPerpsWithdrawalEventData;
+}
+/**
+ * - Includes most properties from the REST API's {@link KatanaPerpsWithdrawal} type.
+ * - Additionally includes the
+ *    {@link KatanaPerpsWithdrawalEventData.wallet wallet},
+ *    {@link KatanaPerpsWithdrawalEventData.time time},
+ *    and {@link KatanaPerpsWithdrawalEventData.quoteBalance quoteBalance} properties.
+ *
+ * @category WebSocket - Message Types
+ * @category KatanaPerps - Get Withdrawals
+ */
+export interface KatanaPerpsWithdrawalEventData extends Pick<KatanaPerpsWithdrawal, 'withdrawalId' | 'quantity' | 'asset' | 'gas'> {
+    /**
+     * Wallet address
+     */
+    wallet: string;
+    /**
+     * Quote token balance after the withdrawal
+     */
+    quoteBalance: string;
+    /**
+     * Timestamp of debiting the withdrawn frond from the exchange
+     */
+    time: number;
+}
+export interface WebSocketResponseSubscriptionMessageShortWithdrawals extends KatanaPerpsSubscriptionEventBase {
+    type: typeof MessageEventType.withdrawals;
+    data: WebSocketResponseWithdrawalsShort;
+}
+/**
+ * @internal
+ */
+export interface WebSocketResponseWithdrawalsShort {
+    /**
+     * @see inflated {@link KatanaPerpsWithdrawalEventData.wallet}
+     */
+    w: KatanaPerpsWithdrawalEventData['wallet'];
+    /**
+     * @see inflated {@link KatanaPerpsWithdrawalEventData.withdrawalId}
+     */
+    i: KatanaPerpsWithdrawalEventData['withdrawalId'];
+    /**
+     * @see inflated {@link KatanaPerpsWithdrawalEventData.asset}
+     */
+    a: KatanaPerpsWithdrawalEventData['asset'];
+    /**
+     * @see inflated {@link KatanaPerpsWithdrawalEventData.quantity}
+     */
+    q: KatanaPerpsWithdrawalEventData['quantity'];
+    /**
+     * @see inflated {@link KatanaPerpsWithdrawalEventData.quoteBalance}
+     */
+    qb: KatanaPerpsWithdrawalEventData['quoteBalance'];
+    /**
+     * @see inflated {@link KatanaPerpsWithdrawalEventData.gas}
+     */
+    g: KatanaPerpsWithdrawalEventData['gas'];
+    /**
+     * @see inflated {@link KatanaPerpsWithdrawalEventData.time}
+     */
+    t: KatanaPerpsWithdrawalEventData['time'];
+}
+//# sourceMappingURL=withdrawals.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"withdrawals.d.ts","sourceRoot":"","sources":["../../../../src/types/webSocket/response/withdrawals.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAClF,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,uBAAuB,CAAC;AAE9E;;;;;GAKG;AACH,MAAM,WAAW,0BACf,SAAQ,gCAAgC;IACxC;;OAEG;IACH,IAAI,EAAE,OAAO,gBAAgB,CAAC,WAAW,CAAC;IAC1C;;;;OAIG;IACH,IAAI,EAAE,8BAA8B,CAAC;CACtC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,8BACf,SAAQ,IAAI,CACV,qBAAqB,EACrB,cAAc,GAAG,UAAU,GAAG,OAAO,GAAG,KAAK,CAC9C;IACD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oDACf,SAAQ,gCAAgC;IACxC,IAAI,EAAE,OAAO,gBAAgB,CAAC,WAAW,CAAC;IAC1C,IAAI,EAAE,iCAAiC,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,CAAC,EAAE,8BAA8B,CAAC,QAAQ,CAAC,CAAC;IAC5C;;OAEG;IACH,CAAC,EAAE,8BAA8B,CAAC,cAAc,CAAC,CAAC;IAClD;;OAEG;IACH,CAAC,EAAE,8BAA8B,CAAC,OAAO,CAAC,CAAC;IAC3C;;OAEG;IACH,CAAC,EAAE,8BAA8B,CAAC,UAAU,CAAC,CAAC;IAC9C;;OAEG;IACH,EAAE,EAAE,8BAA8B,CAAC,cAAc,CAAC,CAAC;IACnD;;OAEG;IACH,CAAC,EAAE,8BAA8B,CAAC,KAAK,CAAC,CAAC;IACzC;;OAEG;IACH,CAAC,EAAE,8BAA8B,CAAC,MAAM,CAAC,CAAC;CAC3C"}

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

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

package/dist/utils.d.ts

@@ -0,0 +1,63 @@
+import { ethers } from 'ethers';
+import * as constants from '#constants';
+import type { AnyObj } from '#types/utils';
+export declare const isNode: boolean;
+export declare function createHmacRestRequestSignatureHeader(payload: string, secret: string): {
+    [constants.REST_HMAC_SIGNATURE_HEADER]: string;
+};
+/**
+ * Creates a new wallet and nonce to use for delegated keys
+ *
+ * @internal
+ */
+export declare function createDelegatedKeyWalletAndNonce(): readonly [
+    ethers.HDNodeWallet,
+    string
+];
+/**
+ * - For use internally at Katana Perps and may be removed or changed anywhere it is implemented without warning.
+ *
+ * @internal
+ */
+export declare const INTERNAL_SYMBOL: unique symbol;
+/**
+ * Asserts that the provided nonce is a uuid v1 string.
+ *
+ * @internal
+ */
+export declare function assertNonceIsValid(nonce: string): asserts nonce is string;
+export declare function deriveBaseURL(options: {
+    sandbox?: boolean;
+    overrideBaseURL?: string;
+    api: 'rest' | 'websocket';
+    baseRestApiURL?: string;
+    baseWebSocketURL?: string;
+}): string;
+/**
+ * URLSearchParams encodes undefined and null as strings, we remove them as a
+ * precaution if this happens.
+ */
+export declare function sanitizeSearchParams(searchParams?: URLSearchParams | AnyObj | undefined): URLSearchParams;
+/**
+ * By using this in default switch case, we can enforce exhaustive check of all case cases.
+ *
+ * @example
+ * ```typescript
+ *  switch (prop) {
+ *    // ...
+ *    default:
+ *      throw new UnreachableCaseError(prop);
+ *  }
+ * ```
+ *
+ * @internal
+ */
+export declare class UnreachableCaseError extends Error {
+    /**
+     *
+     * @param value The value being switched that caused the default case to be reached.
+     * @param info Optionally the name of the fn or switch that caused the error for logging.
+     */
+    constructor(value: never, info?: string);
+}
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGhC,OAAO,KAAK,SAAS,MAAM,YAAY,CAAC;AAExC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAK3C,eAAO,MAAM,MAAM,SAGY,CAAC;AAEhC,wBAAgB,oCAAoC,CAClD,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb;IAAE,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,MAAM,CAAA;CAAE,CAMpD;AAWD;;;;GAIG;AACH,wBAAgB,gCAAgC,IAAI,SAAS;IAC3D,MAAM,CAAC,YAAY;IACnB,MAAM;CACP,CAKA;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe,eAAsC,CAAC;AAEnE;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,IAAI,MAAM,CAWzE;AAED,wBAAgB,aAAa,CAAC,OAAO,EAAE;IACrC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,GAAG,MAAM,CAkDT;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,YAAY,GAAE,eAAe,GAAG,MAAM,GAAG,SAAc,mBAaxD;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,oBAAqB,SAAQ,KAAK;IAC7C;;;;OAIG;gBACS,KAAK,EAAE,KAAK,EAAE,IAAI,SAAW;CAK1C"}