binance 3.0.0-beta.0 → 3.0.0-beta.10

package/lib/types/websockets/ws-api.d.ts

@@ -1,9 +1,8 @@
 import { WS_KEY_MAP, WsKey } from '../../util/websockets/websocket-util';
-import { FuturesAccountBalance, FuturesAccountInformation, FuturesExchangeInfo, NewFuturesOrderParams } from '../futures';
-import { numberInString } from '../shared';
+import { FuturesExchangeInfo, NewFuturesOrderParams } from '../futures';
 import { ExchangeInfo, NewSpotOrderParams, OrderResponse } from '../spot';
-import { WSAPIRecvWindowTimestamp } from './ws-api-requests';
-import { WsAPISessionStatus } from './ws-api-responses';
+import { WSAPIAccountCommissionWSAPIRequest, WSAPIAccountInformationRequest, WSAPIAllOrderListsRequest, WSAPIAllOrdersRequest, WSAPIAvgPriceRequest, WSAPIExchangeInfoRequest, WSAPIFuturesOrderBookRequest, WSAPIFuturesOrderCancelRequest, WSAPIFuturesOrderModifyRequest, WSAPIFuturesOrderStatusRequest, WSAPIFuturesTickerBookRequest, WSAPIFuturesTickerPriceRequest, WSAPIKlinesRequest, WSAPIMyAllocationsRequest, WSAPIMyPreventedMatchesRequest, WSAPIMyTradesRequest, WSAPIOpenOrdersCancelAllRequest, WSAPIOpenOrdersStatusRequest, WSAPIOrderAmendKeepPriorityRequest, WSAPIOrderBookRequest, WSAPIOrderCancelReplaceRequest, WSAPIOrderCancelRequest, WSAPIOrderListCancelRequest, WSAPIOrderListPlaceOCORequest, WSAPIOrderListPlaceOTOCORequest, WSAPIOrderListPlaceOTORequest, WSAPIOrderListPlaceRequest, WSAPIOrderListStatusRequest, WSAPIOrderStatusRequest, WSAPIOrderTestRequest, WSAPIRecvWindowTimestamp, WSAPISessionLogonRequest, WSAPISOROrderPlaceRequest, WSAPISOROrderTestRequest, WSAPITicker24hrRequest, WSAPITickerBookRequest, WSAPITickerPriceRequest, WSAPITickerRequest, WSAPITickerTradingDayRequest, WSAPITradesAggregateRequest, WSAPITradesHistoricalRequest, WSAPITradesRecentRequest } from './ws-api-requests';
+import { WSAPIAccountCommission, WSAPIAccountInformation, WSAPIAggregateTrade, WSAPIAllocation, WSAPIAvgPrice, WSAPIBookTicker, WSAPIFullTicker, WSAPIFuturesAccountBalanceItem, WSAPIFuturesAccountStatus, WSAPIFuturesBookTicker, WSAPIFuturesOrder, WSAPIFuturesOrderBook, WSAPIFuturesPosition, WSAPIFuturesPositionV2, WSAPIFuturesPriceTicker, WSAPIKline, WSAPIMiniTicker, WSAPIOrder, WSAPIOrderBook, WSAPIOrderCancel, WSAPIOrderCancelReplaceResponse, WSAPIOrderListCancelResponse, WSAPIOrderListPlaceResponse, WSAPIOrderListStatusResponse, WSAPIOrderTestResponse, WSAPIOrderTestWithCommission, WSAPIPreventedMatch, WSAPIPriceTicker, WSAPIRateLimit, WSAPIServerTime, WSAPISessionStatus, WSAPISOROrderPlaceResponse, WSAPISOROrderTestResponse, WSAPISOROrderTestResponseWithCommission, WSAPITrade } from './ws-api-responses';
 /**
  * Standard WS commands (for consumers)
  */
@@ -11,14 +10,18 @@ export type WsOperation = 'SUBSCRIBE' | 'UNSUBSCRIBE' | 'LIST_SUBSCRIPTIONS' | '
 /**
  * WS API commands (for sending requests via WS)
  */
-export declare const WS_API_Operations: readonly ["session.logon", "session.status", "session.logout", "ping", "time", "exchangeInfo", "depth", "v2/account.balance", "account.balance", "v2/account.status", "account.status", "order.place", "orderList.place", "sor.order.place"];
+export declare const WS_API_Operations: readonly ["session.logon", "session.status", "session.logout", "ping", "time", "exchangeInfo", "depth", "trades.recent", "trades.historical", "trades.aggregate", "klines", "uiKlines", "avgPrice", "ticker.24hr", "ticker.tradingDay", "ticker", "ticker.price", "ticker.book", "account.status", "account.commission", "account.rateLimits.orders", "allOrders", "allOrderLists", "myTrades", "myPreventedMatches", "myAllocations", "v2/account.balance", "account.balance", "v2/account.status", "account.position", "v2/account.position", "order.place", "order.test", "order.status", "order.cancel", "order.cancelReplace", "order.amend.keepPriority", "order.modify", "openOrders.status", "openOrders.cancelAll", "orderList.place", "orderList.place.oco", "orderList.place.oto", "orderList.place.otoco", "orderList.status", "orderList.cancel", "openOrderLists.status", "sor.order.place", "sor.order.test", "userDataStream.start", "userDataStream.ping", "userDataStream.stop", "userDataStream.subscribe", "userDataStream.unsubscribe"];
+export interface WSAPIUserDataListenKeyRequest {
+    apiKey: string;
+    listenKey: string;
+}
 export type WsAPIOperation = (typeof WS_API_Operations)[number];
 export interface WsRequestOperationBinance<TWSTopic extends string, TWSParams extends object = any> {
     method: WsOperation | WsAPIOperation;
     params?: (TWSTopic | string | number)[] | TWSParams;
     id: number;
 }
-export interface WSAPIResponse<TResponseData extends object = object, TOperation extends WsAPIOperation = WsAPIOperation> {
+export interface WSAPIResponse<TResponseData extends object = object> {
     /** Auto-generated */
     id: string;
     status: number;
@@ -32,6 +35,7 @@ export interface WSAPIResponse<TResponseData extends object = object, TOperation
     }[];
     wsKey: WsKey;
     isWSAPIResponse: boolean;
+    request?: any;
 }
 export type Exact<T> = {} & {
     [K in keyof T]: T[K];
@@ -59,7 +63,10 @@ export interface WsAPIWsKeyTopicMap {
     [WS_KEY_MAP.mainWSAPITestnet]: WsAPIOperation;
     [WS_KEY_MAP.usdmWSAPI]: WsAPIOperation;
     [WS_KEY_MAP.usdmWSAPITestnet]: WsAPIOperation;
+    [WS_KEY_MAP.coinmWSAPI]: WsAPIOperation;
+    [WS_KEY_MAP.coinmWSAPITestnet]: WsAPIOperation;
 }
+export type WsAPIFuturesWsKey = typeof WS_KEY_MAP.usdmWSAPI | typeof WS_KEY_MAP.usdmWSAPITestnet;
 /**
  * Request parameters expected per operation.
  *
@@ -68,7 +75,7 @@ export interface WsAPIWsKeyTopicMap {
  *
  * Make sure to add new topics to WS_API_Operations and the response param map too.
  */
-export interface WsAPITopicRequestParamMap {
+export interface WsAPITopicRequestParamMap<TWSKey = WsKey> {
     SUBSCRIBE: never;
     UNSUBSCRIBE: never;
     LIST_SUBSCRIPTIONS: never;
@@ -78,11 +85,7 @@ export interface WsAPITopicRequestParamMap {
      * Authentication commands & parameters:
      * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/authentication-requests
      */
-    'session.logon': {
-        apiKey: string;
-        signature: string;
-        timestamp: number;
-    };
+    'session.logon': WSAPISessionLogonRequest;
     'session.status': void;
     'session.logout': void;
     /**
@@ -91,48 +94,101 @@ export interface WsAPITopicRequestParamMap {
      */
     ping: void;
     time: void;
-    exchangeInfo: void | {
-        symbol?: string;
-        symbols?: string[];
-        permissions?: string[];
-        showPermissionSets?: boolean;
-        symbolStatus?: string;
-    };
+    exchangeInfo: void | WSAPIExchangeInfoRequest;
     /**
      * Market data requests & parameters:
+     * - Spot:
      * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/market-data-requests
+     * - Futures:
+     * https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/websocket-api
      */
-    depth: {
-        symbol: string;
-        limit: number;
-    };
+    depth: TWSKey extends WsAPIFuturesWsKey ? WSAPIFuturesOrderBookRequest : WSAPIOrderBookRequest;
+    'trades.recent': WSAPITradesRecentRequest;
+    'trades.historical': WSAPITradesHistoricalRequest;
+    'trades.aggregate': WSAPITradesAggregateRequest;
+    klines: WSAPIKlinesRequest;
+    uiKlines: WSAPIKlinesRequest;
+    avgPrice: WSAPIAvgPriceRequest;
+    'ticker.24hr': void | WSAPITicker24hrRequest;
+    'ticker.tradingDay': WSAPITickerTradingDayRequest;
+    ticker: WSAPITickerRequest;
+    'ticker.price': void | TWSKey extends WsAPIFuturesWsKey ? WSAPIFuturesTickerPriceRequest | undefined : WSAPITickerPriceRequest | undefined;
+    'ticker.book': void | TWSKey extends WsAPIFuturesWsKey ? WSAPIFuturesTickerBookRequest | undefined : WSAPITickerBookRequest | undefined;
     /**
      * Account requests & parameters:
      * - Spot:
      * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/account-requests
-     *
      * - Futures:
      * https://developers.binance.com/docs/derivatives/usds-margined-futures/account/websocket-api
      */
+    'account.status': void | (TWSKey extends WsAPIFuturesWsKey ? WSAPIRecvWindowTimestamp : WSAPIAccountInformationRequest);
+    'account.rateLimits.orders': void | WSAPIRecvWindowTimestamp;
+    allOrders: WSAPIAllOrdersRequest;
+    allOrderLists: void | WSAPIAllOrderListsRequest;
+    myTrades: WSAPIMyTradesRequest;
+    myPreventedMatches: WSAPIMyPreventedMatchesRequest;
+    myAllocations: WSAPIMyAllocationsRequest;
+    'account.commission': WSAPIAccountCommissionWSAPIRequest;
     /**
-     * Spot:
-     */
-    /**
-     * Futures:
+     * Futures account requests & parameters:
+     * https://developers.binance.com/docs/derivatives/usds-margined-futures/account/websocket-api
      */
-    'v2/account.balance': WSAPIRecvWindowTimestamp;
+    'account.position': WSAPIRecvWindowTimestamp;
+    'v2/account.position': WSAPIRecvWindowTimestamp;
     'account.balance': WSAPIRecvWindowTimestamp;
+    'v2/account.balance': WSAPIRecvWindowTimestamp;
     'v2/account.status': WSAPIRecvWindowTimestamp;
-    'account.status': WSAPIRecvWindowTimestamp;
     /**
      * Trading requests & parameters:
+     * - Spot:
      * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/trading-requests
+     * - Futures:
+     * https://developers.binance.com/docs/derivatives/usds-margined-futures/trading/websocket-api
      */
-    'order.place': (NewSpotOrderParams | NewFuturesOrderParams) & {
+    'order.place': (TWSKey extends WsAPIFuturesWsKey ? NewFuturesOrderParams : NewSpotOrderParams) & {
         timestamp?: number;
     };
-    'orderList.place': any;
-    'sor.order.place': any;
+    'order.test': WSAPIOrderTestRequest;
+    'order.status': TWSKey extends WsAPIFuturesWsKey ? WSAPIFuturesOrderStatusRequest : WSAPIOrderStatusRequest;
+    'order.cancel': TWSKey extends WsAPIFuturesWsKey ? WSAPIFuturesOrderCancelRequest : WSAPIOrderCancelRequest;
+    'order.modify': WSAPIFuturesOrderModifyRequest;
+    'order.cancelReplace': WSAPIOrderCancelReplaceRequest;
+    'order.amend.keepPriority': WSAPIOrderAmendKeepPriorityRequest;
+    'openOrders.status': WSAPIOpenOrdersStatusRequest;
+    'openOrders.cancelAll': WSAPIOpenOrdersCancelAllRequest;
+    /**
+     * Order list requests & parameters:
+     */
+    'orderList.place': WSAPIOrderListPlaceRequest;
+    'orderList.place.oco': WSAPIOrderListPlaceOCORequest;
+    'orderList.place.oto': WSAPIOrderListPlaceOTORequest;
+    'orderList.place.otoco': WSAPIOrderListPlaceOTOCORequest;
+    'orderList.status': WSAPIOrderListStatusRequest;
+    'orderList.cancel': WSAPIOrderListCancelRequest;
+    'openOrderLists.status': WSAPIRecvWindowTimestamp;
+    /**
+     * SOR requests & parameters:
+     */
+    'sor.order.place': WSAPISOROrderPlaceRequest;
+    'sor.order.test': WSAPISOROrderTestRequest;
+    /**
+     * User data stream:
+     *
+     * - Spot:
+     * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/user-data-stream-requests
+     *
+     * - Futures:
+     * https://developers.binance.com/docs/derivatives/usds-margined-futures/account/websocket-api
+     *
+     * Note: for the user data stream, use the subscribe*UserDataStream() methods from the WS Client.
+     */
+    'userDataStream.start': {
+        apiKey: string;
+    };
+    'userDataStream.ping': WSAPIUserDataListenKeyRequest;
+    'userDataStream.stop': WSAPIUserDataListenKeyRequest;
+    'userDataStream.subscribe': void;
+    'userDataStream.unsubscribe': void;
 }
 /**
  * Response structure expected for each operation
@@ -152,50 +208,91 @@ export interface WsAPIOperationResponseMap {
      * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/session-authentication
      * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/authentication-requests
      */
-    'session.login': WSAPIResponse<WsAPISessionStatus>;
-    'session.status': WSAPIResponse<WsAPISessionStatus>;
-    'session.logout': WSAPIResponse<WsAPISessionStatus>;
+    'session.login': WSAPIResponse<WSAPISessionStatus>;
+    'session.status': WSAPIResponse<WSAPISessionStatus>;
+    'session.logout': WSAPIResponse<WSAPISessionStatus>;
     /**
      * General responses:
      * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/general-requests
      */
-    ping: {};
-    time: WSAPIResponse<{
-        serverTime: number;
-    }>;
+    ping: unknown;
+    time: WSAPIResponse<WSAPIServerTime>;
     exchangeInfo: WSAPIResponse<FuturesExchangeInfo | ExchangeInfo>;
     /**
      * Market data responses
+     * - Spot:
      * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/market-data-requests
+     * - Futures:
+     * https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/websocket-api
      */
-    depth: WSAPIResponse<{
-        lastUpdateId: number;
-        bids: [numberInString, numberInString][];
-        asks: [numberInString, numberInString][];
-    }>;
+    depth: WSAPIResponse<WSAPIOrderBook | WSAPIFuturesOrderBook>;
+    'trades.recent': WSAPIResponse<WSAPITrade[]>;
+    'trades.historical': WSAPIResponse<WSAPITrade[]>;
+    'trades.aggregate': WSAPIResponse<WSAPIAggregateTrade[]>;
+    klines: WSAPIResponse<WSAPIKline[]>;
+    uiKlines: WSAPIResponse<WSAPIKline[]>;
+    avgPrice: WSAPIResponse<WSAPIAvgPrice>;
+    'ticker.24hr': WSAPIResponse<WSAPIFullTicker | WSAPIMiniTicker | WSAPIFullTicker[] | WSAPIMiniTicker[]>;
+    'ticker.tradingDay': WSAPIResponse<WSAPIFullTicker | WSAPIMiniTicker | WSAPIFullTicker[] | WSAPIMiniTicker[]>;
+    ticker: WSAPIResponse<WSAPIFullTicker | WSAPIMiniTicker | WSAPIFullTicker[] | WSAPIMiniTicker[]>;
+    'ticker.price': WSAPIResponse<WSAPIPriceTicker | WSAPIPriceTicker[] | WSAPIFuturesPriceTicker | WSAPIFuturesPriceTicker[]>;
+    'ticker.book': WSAPIResponse<WSAPIBookTicker | WSAPIBookTicker[] | WSAPIFuturesBookTicker | WSAPIFuturesBookTicker[]>;
     /**
-     * Account requests & parameters:
-     * - Spot:
+     * Account responses:
      * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/account-requests
-     *
-     * - Futures:
+     */
+    'account.status': WSAPIResponse<WSAPIAccountInformation | WSAPIFuturesAccountStatus>;
+    'account.commission': WSAPIResponse<WSAPIAccountCommission>;
+    'account.rateLimits.orders': WSAPIResponse<WSAPIRateLimit[]>;
+    allOrders: WSAPIResponse<WSAPIOrder[]>;
+    allOrderLists: WSAPIResponse<WSAPIOrderListStatusResponse[]>;
+    myTrades: WSAPIResponse<WSAPITrade[]>;
+    myPreventedMatches: WSAPIResponse<WSAPIPreventedMatch[]>;
+    myAllocations: WSAPIResponse<WSAPIAllocation[]>;
+    /**
+     * Futures account responses:
      * https://developers.binance.com/docs/derivatives/usds-margined-futures/account/websocket-api
      */
+    'account.position': WSAPIResponse<WSAPIFuturesPosition[]>;
+    'v2/account.position': WSAPIResponse<WSAPIFuturesPositionV2[]>;
+    'account.balance': WSAPIResponse<WSAPIFuturesAccountBalanceItem[]>;
+    'v2/account.balance': WSAPIResponse<WSAPIFuturesAccountBalanceItem[]>;
+    'v2/account.status': WSAPIResponse<WSAPIFuturesAccountStatus>;
     /**
-     * Spot:
+     * Trading responses
+     * - Spot:
+     * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/trading-requests
+     * - Futures:
+     * https://developers.binance.com/docs/derivatives/usds-margined-futures/trading/websocket-api
      */
+    'order.place': WSAPIResponse<OrderResponse | WSAPIFuturesOrder>;
+    'order.test': WSAPIResponse<WSAPIOrderTestResponse | WSAPIOrderTestWithCommission>;
+    'order.status': WSAPIResponse<WSAPIOrder | WSAPIFuturesOrder>;
+    'order.cancel': WSAPIResponse<WSAPIOrderCancel | WSAPIFuturesOrder>;
+    'order.modify': WSAPIResponse<WSAPIFuturesOrder>;
+    'order.cancelReplace': WSAPIResponse<WSAPIOrderCancelReplaceResponse>;
+    'openOrders.status': WSAPIResponse<WSAPIOrder[] | WSAPIFuturesOrder[]>;
+    'openOrders.cancelAll': WSAPIResponse<(WSAPIOrderCancel | WSAPIOrderListCancelResponse)[]>;
     /**
-     * Futures:
+     * Order list responses
      */
-    'v2/account.balance': FuturesAccountBalance;
-    'account.balance': FuturesAccountBalance;
-    'v2/account.status': FuturesAccountInformation;
-    'account.status': FuturesAccountInformation;
+    'orderList.place': WSAPIResponse<WSAPIOrderListPlaceResponse>;
+    'orderList.place.oco': WSAPIResponse<WSAPIOrderListPlaceResponse>;
+    'orderList.place.oto': WSAPIResponse<WSAPIOrderListPlaceResponse>;
+    'orderList.place.otoco': WSAPIResponse<WSAPIOrderListPlaceResponse>;
+    'orderList.status': WSAPIResponse<WSAPIOrderListStatusResponse>;
+    'orderList.cancel': WSAPIResponse<WSAPIOrderListCancelResponse>;
+    'openOrderLists.status': WSAPIResponse<WSAPIOrderListStatusResponse[]>;
     /**
-     * Trading responses
-     * https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/trading-requests
+     * SOR responses
      */
-    'order.place': WSAPIResponse<OrderResponse>;
-    'orderList.place': WSAPIResponse<any>;
-    'sor.order.place': WSAPIResponse<any>;
+    'sor.order.place': WSAPIResponse<WSAPISOROrderPlaceResponse>;
+    'sor.order.test': WSAPIResponse<WSAPISOROrderTestResponse | WSAPISOROrderTestResponseWithCommission>;
+    'userDataStream.start': WSAPIResponse<{
+        listenKey: string;
+    }>;
+    'userDataStream.ping': WSAPIResponse<object>;
+    'userDataStream.stop': WSAPIResponse<object>;
+    'userDataStream.subscribe': WSAPIResponse<object>;
+    'userDataStream.unsubscribe': WSAPIResponse<object>;
 }

package/lib/types/websockets/ws-api.js

@@ -13,17 +13,61 @@ exports.WS_API_Operations = [
     'ping',
     'time',
     'exchangeInfo',
-    //// Market data commands //TODO:
+    //// Market data commands
     'depth',
+    'trades.recent',
+    'trades.historical',
+    'trades.aggregate',
+    'klines',
+    'uiKlines',
+    'avgPrice',
+    'ticker.24hr',
+    'ticker.tradingDay',
+    'ticker',
+    'ticker.price',
+    'ticker.book',
     //// Account commands
+    // Spot
+    'account.status',
+    'account.commission',
+    'account.rateLimits.orders',
+    'allOrders',
+    'allOrderLists',
+    'myTrades',
+    'myPreventedMatches',
+    'myAllocations',
     // Futures
     'v2/account.balance',
     'account.balance',
     'v2/account.status',
-    'account.status',
-    //// Trading commands // TODO:
+    'account.position',
+    'v2/account.position',
+    //// Trading commands
     'order.place',
+    'order.test',
+    'order.status',
+    'order.cancel',
+    'order.cancelReplace',
+    'order.amend.keepPriority',
+    'order.modify',
+    'openOrders.status',
+    'openOrders.cancelAll',
+    // Order list commands
     'orderList.place',
+    'orderList.place.oco',
+    'orderList.place.oto',
+    'orderList.place.otoco',
+    'orderList.status',
+    'orderList.cancel',
+    'openOrderLists.status',
+    // SOR commands
     'sor.order.place',
+    'sor.order.test',
+    // user data stream
+    'userDataStream.start',
+    'userDataStream.ping',
+    'userDataStream.stop',
+    'userDataStream.subscribe',
+    'userDataStream.unsubscribe',
 ];
 //# sourceMappingURL=ws-api.js.map

package/lib/types/websockets/ws-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"ws-api.js","sourceRoot":"","sources":["../../../src/types/websockets/ws-api.ts"],"names":[],"mappings":";;;AAAA,yEAAyE;AA2BzE;;GAEG;AACU,QAAA,iBAAiB,GAAG;IAC/B,eAAe;IACf,gBAAgB;IAChB,gBAAgB;IAChB,qBAAqB;IACrB,MAAM;IACN,MAAM;IACN,cAAc;IACd,iCAAiC;IACjC,OAAO;IACP,qBAAqB;IACrB,UAAU;IACV,oBAAoB;IACpB,iBAAiB;IACjB,mBAAmB;IACnB,gBAAgB;IAChB,8BAA8B;IAC9B,aAAa;IACb,iBAAiB;IACjB,iBAAiB;CACT,CAAC"}
+{"version":3,"file":"ws-api.js","sourceRoot":"","sources":["../../../src/types/websockets/ws-api.ts"],"names":[],"mappings":";;;AAAA,yEAAyE;AA+FzE;;GAEG;AACU,QAAA,iBAAiB,GAAG;IAC/B,eAAe;IACf,gBAAgB;IAChB,gBAAgB;IAChB,qBAAqB;IACrB,MAAM;IACN,MAAM;IACN,cAAc;IACd,yBAAyB;IACzB,OAAO;IACP,eAAe;IACf,mBAAmB;IACnB,kBAAkB;IAClB,QAAQ;IACR,UAAU;IACV,UAAU;IACV,aAAa;IACb,mBAAmB;IACnB,QAAQ;IACR,cAAc;IACd,aAAa;IACb,qBAAqB;IACrB,OAAO;IACP,gBAAgB;IAChB,oBAAoB;IACpB,2BAA2B;IAC3B,WAAW;IACX,eAAe;IACf,UAAU;IACV,oBAAoB;IACpB,eAAe;IACf,UAAU;IACV,oBAAoB;IACpB,iBAAiB;IACjB,mBAAmB;IACnB,kBAAkB;IAClB,qBAAqB;IACrB,qBAAqB;IACrB,aAAa;IACb,YAAY;IACZ,cAAc;IACd,cAAc;IACd,qBAAqB;IACrB,0BAA0B;IAC1B,cAAc;IACd,mBAAmB;IACnB,sBAAsB;IACtB,sBAAsB;IACtB,iBAAiB;IACjB,qBAAqB;IACrB,qBAAqB;IACrB,uBAAuB;IACvB,kBAAkB;IAClB,kBAAkB;IAClB,uBAAuB;IACvB,eAAe;IACf,iBAAiB;IACjB,gBAAgB;IAChB,mBAAmB;IACnB,sBAAsB;IACtB,qBAAqB;IACrB,qBAAqB;IACrB,0BAA0B;IAC1B,4BAA4B;CACpB,CAAC"}

package/lib/types/websockets/ws-events-formatted.d.ts

@@ -1,5 +1,5 @@
-import { FuturesContractType, PositionSide, MarginType, FuturesOrderType, WorkingType } from '../futures';
-import { KlineInterval, numberInString, OrderBookRowFormatted, OrderSide, OrderType, OrderTimeInForce, OrderExecutionType, OrderStatus, SelfTradePreventionMode, OCOStatus, OCOOrderStatus } from '../shared';
+import { FuturesContractType, FuturesOrderType, MarginType, PositionSide, WorkingType } from '../futures';
+import { KlineInterval, numberInString, OCOOrderStatus, OCOStatus, OrderBookRowFormatted, OrderExecutionType, OrderSide, OrderStatus, OrderTimeInForce, OrderType, SelfTradePreventionMode } from '../shared';
 import { AccountUpdateEventType } from './ws-events-raw';
 import { WsSharedBase } from './ws-general';
 export interface WsMessageKlineFormatted extends WsSharedBase {
@@ -90,7 +90,7 @@ export interface WsMessage24hrMiniTickerFormatted extends WsSharedBase {
     quoteAssetVolume: number;
 }
 export interface WsMessage24hrTickerFormatted extends WsSharedBase {
-    eventType: '24hrTicker';
+    eventType: '24hrTicker' | '!ticker@arr';
     eventTime: number;
     symbol: string;
     priceChange: number;
@@ -115,27 +115,31 @@ export interface WsMessage24hrTickerFormatted extends WsSharedBase {
     trades: number;
 }
 export interface WsMessageRollingWindowTickerFormatted extends WsSharedBase {
-    eventType: '1hTicker' | '4hTicker' | '1dTicker';
+    eventType: 'ticker';
     eventTime: number;
     symbol: string;
     priceChange: number;
     priceChangePercent: number;
     weightedAveragePrice: number;
-    openPrice: number;
-    highPrice: number;
-    lowPrice: number;
-    lastPrice: number;
-    totalTradedBaseAssetVolume: number;
-    totalTradedQuoteAssetVolume: number;
-    statisticsOpenTime: number;
-    statisticsCloseTime: number;
+    open: number;
+    high: number;
+    low: number;
+    currentClose: number;
+    baseAssetVolume: number;
+    quoteAssetVolume: number;
+    openTime: number;
+    closeTime: number;
     firstTradeId: number;
     lastTradeId: number;
-    totalTrades: number;
+    trades: number;
+    streamName: string;
+    isWSAPIResponse: false;
 }
 export interface WsMessageBookTickerEventFormatted extends WsSharedBase {
     eventType: 'bookTicker';
     updateId: number;
+    eventTime: number;
+    transactionTime: number;
     symbol: string;
     bidPrice: number;
     bidQty: number;
@@ -143,7 +147,7 @@ export interface WsMessageBookTickerEventFormatted extends WsSharedBase {
     askQty: number;
 }
 export interface WsMessagePartialBookDepthEventFormatted extends WsSharedBase {
-    eventType: 'partialBookDepth';
+    eventType: 'partialBookDepth' | 'string';
     lastUpdateId: number;
     bids: OrderBookRowFormatted[];
     asks: OrderBookRowFormatted[];

package/lib/types/websockets/ws-events-raw.d.ts

@@ -1,5 +1,5 @@
-import { PositionSide, MarginType, FuturesOrderType, WorkingType } from '../futures';
-import { KlineInterval, numberInString, OrderBookRow, OrderSide, OrderType, OrderTimeInForce, OrderExecutionType, OrderStatus, SelfTradePreventionMode, OCOStatus, OCOOrderStatus } from '../shared';
+import { FuturesOrderType, MarginType, PositionSide, WorkingType } from '../futures';
+import { KlineInterval, numberInString, OCOOrderStatus, OCOStatus, OrderBookRow, OrderExecutionType, OrderSide, OrderStatus, OrderTimeInForce, OrderType, SelfTradePreventionMode } from '../shared';
 import { WsSharedBase } from './ws-general';
 export interface WsMessageKlineRaw extends WsSharedBase {
     e: 'kline';
@@ -109,6 +109,8 @@ export interface WsMessageRollingWindowTickerRaw extends WsSharedBase {
 export interface WsMessageBookTickerEventRaw extends WsSharedBase {
     e: 'bookTicker';
     u: number;
+    E: number;
+    T: number;
     s: string;
     b: numberInString;
     B: numberInString;

package/lib/types/websockets/ws-general.d.ts

@@ -12,6 +12,7 @@ export type WsMarket = 'spot' | 'spotTestnet' | 'crossMargin' | 'isolatedMargin'
 export interface WsSharedBase {
     wsMarket: WsMarket;
     wsKey: WsKey;
+    streamName: string;
 }
 export interface WsResponse {
     type: 'message';
@@ -32,7 +33,6 @@ export type WsPrivateUSDTPerpTopic = 'position' | 'execution' | 'order' | 'stop_
 export type WsPrivateSpotTopic = 'outboundAccountInfo' | 'executionReport' | 'ticketInfo';
 export type WsPrivateTopic = WsPrivateInverseTopic | WsPrivateUSDTPerpTopic | WsPrivateSpotTopic | string;
 export type WsTopic = WsPublicTopics | WsPrivateTopic;
-/** This is used to differentiate product groups on a connection */
 export interface WSClientConfigurableOptions {
     /** Your API key */
     api_key?: string;
@@ -40,20 +40,17 @@ export interface WSClientConfigurableOptions {
     api_secret?: string;
     beautify?: boolean;
     /**
-     * Set to `true` to connect to Bybit's testnet environment.
-     *
-     * Notes:
-     *
-     * - If demo trading, `testnet` should be set to false!
-     * - If testing a strategy, use demo trading instead. Testnet market data is very different from real market conditions.
+     * If true, log a warning if the beautifier is missing anything for an event
      */
-    testnet?: boolean;
+    beautifyWarnIfMissing?: boolean;
     /**
-     * Set to `true` to connect to Bybit's V5 demo trading: https://bybit-exchange.github.io/docs/v5/demo
+     * Set to `true` to connect to Binance's testnet environment.
      *
-     * Only the "V5" "market" is supported here.
+     * Notes:
+     * - Not all WebSocket categories support testnet.
+     * - If testing a strategy, this is not recommended. Testnet market data is very different from real market conditions. More guidance here: https://github.com/tiagosiebler/awesome-crypto-examples/wiki/CEX-Testnets
      */
-    demoTrading?: boolean;
+    testnet?: boolean;
     /** Define a recv window when preparing a private websocket signature. This is in milliseconds, so 5000 == 5 seconds */
     recvWindow?: number;
     disableHeartbeat?: boolean;
@@ -70,13 +67,6 @@ export interface WSClientConfigurableOptions {
         agent?: any;
     };
     wsUrl?: string;
-    /**
-     * Default: true.
-     *
-     * When enabled, any calls to the subscribe method will return a promise.
-     * // TODO:
-     */
-    promiseSubscribe?: boolean;
     /**
      * Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method
      *