@medievalrain/binance-ts 0.9.8 → 0.11.1

package/dist/index.d.ts

@@ -118,6 +118,7 @@ type FuturesExchangeInfoSymbol = {
 };
 type FuturesExchangeInfo = {
   exchangeFilters: unknown[];
+  futuresType: "U_MARGINED";
   rateLimits: FuturesExchangeInfoRateLimit[];
   serverTime: number;
   assets: FuturesExchangeInfoAsset[];
@@ -359,6 +360,7 @@ type FuturesAccountConfig = {
   dualSidePosition: boolean;
   multiAssetsMargin: boolean;
   tradeGroupId: number;
+  updateTime: number;
 };
 type FuturesSymbolConfig = {
   symbol: string;
@@ -744,7 +746,7 @@ type WebsocketClient<CM extends ChannelsMap> = { [K in keyof CM]: {
   off: (cb: (data: CM[K]["messageSchema"]) => void) => void;
 } };
 //#endregion
-//#region src/websocket/futures/types.d.ts
+//#region src/websocket/futures/types/events.d.ts
 type FuturesBookTickerEvent = {
   u: number;
   s: string;
@@ -754,14 +756,9 @@ type FuturesBookTickerEvent = {
   A: string;
 };
 type FuturesBookDepthEvent = {
-  E: number;
-  T: number;
-  s: string;
-  U: number;
-  u: number;
-  pu: number;
-  b: [string, string][];
-  a: [string, string][];
+  lastUpdateId: number;
+  bids: [string, string][];
+  asks: [string, string][];
 };
 type FuturesAggTradeEvent = {
   e: "aggTrade";
@@ -775,6 +772,8 @@ type FuturesAggTradeEvent = {
   T: number;
   m: boolean;
 };
+//#endregion
+//#region src/websocket/futures/types/channels.d.ts
 type FuturesChannels = {
   bookTicker: {
     messageSchema: FuturesBookTickerEvent;
@@ -796,4 +795,206 @@ type FuturesChannels = {
 //#region src/websocket/futures/client.d.ts
 declare const createFuturesWebsocketClient: (baseUrl?: string) => WebsocketClient<FuturesChannels>;
 //#endregion
-export { ApiError, BinanceRestClient, ErrorMessageParsingError, FuturesAccountAsset, FuturesAccountBalance, FuturesAccountConfig, FuturesAccountInfo, FuturesAccountPosition, FuturesAggregateTrade, FuturesAssetIndex, FuturesBasis, FuturesBookDepthEvent, FuturesBookTicker, FuturesBookTickerEvent, FuturesCheckServerTime, FuturesCommissionRate, FuturesCompositeIndex, FuturesCompositeIndexAsset, FuturesContractType, FuturesDeliveryPrice, FuturesExchangeInfo, FuturesExchangeInfoAsset, FuturesExchangeInfoFilter, FuturesExchangeInfoRateLimit, FuturesExchangeInfoSymbol, FuturesFundingInfo, FuturesFundingRate, FuturesGetListenKey, FuturesIncomeHistory, FuturesIncomeType, FuturesIndexPriceConstituentItem, FuturesIndexPriceConstituents, FuturesInsuranceBalance, FuturesInsuranceBalanceAsset, FuturesKline, FuturesKlineInterval, FuturesLeverageBracket, FuturesLeverageBracketEntry, FuturesLongShortRatio, FuturesMarkPrice, FuturesNewOrder, FuturesNewOrderRespType, FuturesOpenInterest, FuturesOpenInterestPeriod, FuturesOpenInterestStats, FuturesOrderBook, FuturesOrderSide, FuturesOrderType, FuturesPositionMode, FuturesPositionSide, FuturesPriceMatch, FuturesSelfTradePrevention, FuturesSymbolConfig, FuturesSymbolPrice, FuturesTakerBuySellRatio, FuturesTestConnectivity, FuturesTicker24h, FuturesTimeInForce, FuturesTrade, FuturesUnderlyingType, FuturesUserRateLimit, FuturesWorkingType, MalformedParamError, PermissionSet, ResponseError, WeightError, createFuturesWebsocketClient };
+//#region src/websocket/futures/types/user.d.ts
+type FuturesListenKeyExpiredEvent = {
+  e: "listenKeyExpired";
+  E: number;
+  listenKey: string;
+};
+type FuturesAccountUpdateEventReason = "DEPOSIT" | "WITHDRAW" | "ORDER" | "FUNDING_FEE" | "WITHDRAW_REJECT" | "ADJUSTMENT" | "INSURANCE_CLEAR" | "ADMIN_DEPOSIT" | "ADMIN_WITHDRAW" | "MARGIN_TRANSFER" | "MARGIN_TYPE_CHANGE" | "ASSET_TRANSFER" | "OPTIONS_PREMIUM_FEE" | "OPTIONS_SETTLE_PROFIT" | "AUTO_EXCHANGE" | "COIN_SWAP_DEPOSIT" | "COIN_SWAP_WITHDRAW";
+type FuturesAccountUpdateEventBalance = {
+  a: string;
+  wb: string;
+  cw: string;
+  bc: string;
+};
+type FuturesPositionSide$1 = "LONG" | "SHORT";
+type FuturesAccountUpdateEventPosition = {
+  s: string;
+  pa: string;
+  ep: string;
+  bep: string;
+  cr: string;
+  up: string;
+  mt: "isolated" & string & {};
+  iw: string;
+  ps: FuturesPositionSide$1;
+};
+type FuturesAccountUpdateEvent = {
+  e: "ACCOUNT_UPDATE";
+  E: number;
+  T: number;
+  a: {
+    m: FuturesAccountUpdateEventReason;
+    B: FuturesAccountUpdateEventBalance[];
+    P: FuturesAccountUpdateEventPosition[];
+  };
+};
+type FuturesMarginCallPosition = {
+  s: string;
+  ps: FuturesPositionSide$1;
+  pa: string;
+  mt: "CROSSED" | "ISOLATED";
+  iw: string;
+  mp: string;
+  up: string;
+  mm: string;
+};
+type FuturesMarginCallEvent = {
+  e: "MARGIN_CALL";
+  E: number;
+  cw: string;
+  p: FuturesMarginCallPosition[];
+};
+type FuturesOrderType$1 = "LIMIT" | "MARKET" | "STOP" | "STOP_MARKET" | "TAKE_PROFIT" | "TAKE_PROFIT_MARKET" | "TRAILING_STOP_MARKET" | "LIQUIDATION";
+type FuturesOrderTimeInForce = "GTC" | "IOC" | "FOK" | "GTX";
+type FuturesOrderExecutionType = "NEW" | "CANCELED" | "CALCULATED" | "EXPIRED" | "TRADE" | "AMENDMENT";
+type FuturesOrderStatus = "NEW" | "PARTIALLY_FILLED" | "FILLED" | "CANCELED" | "EXPIRED" | "EXPIRED_IN_MATCH";
+type FuturesOrderSide$1 = "BUY" | "SELL";
+type FuturesOrderWorkingType = "CONTRACT_PRICE" | "MARK_PRICE";
+type FuturesOrderUpdateEvent = {
+  e: "ORDER_TRADE_UPDATE";
+  E: number;
+  T: number;
+  o: {
+    s: string;
+    c: string;
+    S: FuturesOrderSide$1;
+    o: FuturesOrderType$1;
+    f: FuturesOrderTimeInForce;
+    q: string;
+    p: string;
+    ap: string;
+    sp: string;
+    x: FuturesOrderExecutionType;
+    X: FuturesOrderStatus;
+    i: number;
+    l: string;
+    z: string;
+    L: string;
+    N: string;
+    n: string;
+    T: number;
+    t: number;
+    b: string;
+    a: string;
+    m: boolean;
+    R: boolean;
+    wt: FuturesOrderWorkingType;
+    ot: "TRAILING_STOP_MARKET";
+    ps: FuturesPositionSide$1;
+    cp: boolean;
+    AP: string;
+    cr: string;
+    pP: boolean;
+    si: number;
+    ss: number;
+    rp: string;
+    V: "EXPIRE_TAKER";
+    pm: "OPPONENT";
+    gtd: number;
+    er: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
+  };
+};
+type FuturesTradeLiteEvent = {
+  e: "TRADE_LITE";
+  E: number;
+  T: number;
+  s: string;
+  q: string;
+  p: string;
+  m: boolean;
+  c: string;
+  S: FuturesPositionSide$1;
+  L: string;
+  l: string;
+  t: number;
+  i: number;
+};
+type AccountConfigUpdateEvent = {
+  e: "ACCOUNT_CONFIG_UPDATE";
+  E: number;
+  T: number;
+} & ({
+  ac: {
+    s: string;
+    l: number;
+  };
+} | {
+  ai: {
+    j: boolean;
+  };
+});
+type FuturesStrategyStatus = "NEW" | "WORKING" | "CANCELLED" | "EXPIRED";
+type FuturesStrategyUpdateEvent = {
+  e: "STRATEGY_UPDATE";
+  T: number;
+  E: number;
+  su: {
+    si: number;
+    st: "GRID";
+    ss: FuturesStrategyStatus;
+    s: string;
+    ut: number;
+    c: 8001 | 8002 | 8003 | 8004 | 8005 | 8006 | 8007 | 8008 | 8009 | 8010 | 8011 | 8012 | 8013 | 8014 | 8015;
+  };
+};
+type FuturesGridUpdateEvent = {
+  e: "GRID_UPDATE";
+  T: number;
+  E: number;
+  gu: {
+    si: number;
+    st: "GRID";
+    ss: FuturesStrategyStatus;
+    s: string;
+    r: string;
+    up: string;
+    uq: string;
+    uf: string;
+    mp: string;
+    ut: number;
+  };
+};
+type FuturesConditionalOrderTriggerRejectEvent = {
+  e: "CONDITIONAL_ORDER_TRIGGER_REJECT";
+  T: number;
+  E: number;
+  or: {
+    s: string;
+    i: number;
+    r: string;
+  };
+};
+type FuturesUserEvent = FuturesListenKeyExpiredEvent | FuturesAccountUpdateEvent | FuturesMarginCallEvent | FuturesOrderUpdateEvent | FuturesTradeLiteEvent | AccountConfigUpdateEvent | FuturesStrategyUpdateEvent | FuturesGridUpdateEvent | FuturesConditionalOrderTriggerRejectEvent;
+declare const futuresEventRouting: {
+  readonly listenKeyExpired: "listenKeyExpired";
+  readonly accountUpdate: "ACCOUNT_UPDATE";
+  readonly marginCall: "MARGIN_CALL";
+  readonly orderTradeUpdate: "ORDER_TRADE_UPDATE";
+  readonly tradeLite: "TRADE_LITE";
+  readonly accountConfigUpdate: "ACCOUNT_CONFIG_UPDATE";
+  readonly strategyUpdate: "STRATEGY_UPDATE";
+  readonly gridUpdate: "GRID_UPDATE";
+  readonly conditionalOrderTriggerReject: "CONDITIONAL_ORDER_TRIGGER_REJECT";
+};
+type InferFutruresUserEvent<EventName extends FuturesUserEvent["e"]> = Extract<FuturesUserEvent, {
+  e: EventName;
+}>;
+type FuturesUserWebsocketClient = { [MethodName in keyof typeof futuresEventRouting]: {
+  on: (callback: (data: InferFutruresUserEvent<(typeof futuresEventRouting)[MethodName]>, options?: CallbackOptions) => void) => void;
+  off: (callback: (data: InferFutruresUserEvent<(typeof futuresEventRouting)[MethodName]>, options?: CallbackOptions) => void, options?: CallbackOptions) => void;
+} };
+//#endregion
+//#region src/websocket/futures/user.d.ts
+declare const createFuturesUserWebsocketClient: ({
+  baseUrl,
+  apiKey,
+  apiSecret
+}: {
+  baseUrl?: string;
+  apiKey: string;
+  apiSecret: string;
+}) => Promise<FuturesUserWebsocketClient>;
+//#endregion
+export { ApiError, BinanceRestClient, ErrorMessageParsingError, FuturesAccountAsset, FuturesAccountBalance, FuturesAccountConfig, FuturesAccountInfo, FuturesAccountPosition, FuturesAggTradeEvent, FuturesAggregateTrade, FuturesAssetIndex, FuturesBasis, FuturesBookDepthEvent, FuturesBookTicker, FuturesBookTickerEvent, FuturesCheckServerTime, FuturesCommissionRate, FuturesCompositeIndex, FuturesCompositeIndexAsset, FuturesContractType, FuturesDeliveryPrice, FuturesExchangeInfo, FuturesExchangeInfoAsset, FuturesExchangeInfoFilter, FuturesExchangeInfoRateLimit, FuturesExchangeInfoSymbol, FuturesFundingInfo, FuturesFundingRate, FuturesGetListenKey, FuturesIncomeHistory, FuturesIncomeType, FuturesIndexPriceConstituentItem, FuturesIndexPriceConstituents, FuturesInsuranceBalance, FuturesInsuranceBalanceAsset, FuturesKline, FuturesKlineInterval, FuturesLeverageBracket, FuturesLeverageBracketEntry, FuturesLongShortRatio, FuturesMarkPrice, FuturesNewOrder, FuturesNewOrderRespType, FuturesOpenInterest, FuturesOpenInterestPeriod, FuturesOpenInterestStats, FuturesOrderBook, FuturesOrderSide, FuturesOrderType, FuturesPositionMode, FuturesPositionSide, FuturesPriceMatch, FuturesSelfTradePrevention, FuturesSymbolConfig, FuturesSymbolPrice, FuturesTakerBuySellRatio, FuturesTestConnectivity, FuturesTicker24h, FuturesTimeInForce, FuturesTrade, FuturesUnderlyingType, FuturesUserRateLimit, FuturesWorkingType, MalformedParamError, PermissionSet, ResponseError, WeightError, createFuturesUserWebsocketClient, createFuturesWebsocketClient };

package/dist/index.js

@@ -604,4 +604,86 @@ const createFuturesWebsocketClient = (baseUrl = "wss://stream.binance.com:9443/w
 };
 
 //#endregion
-export { ApiError, BinanceRestClient, ErrorMessageParsingError, MalformedParamError, ResponseError, WeightError, createFuturesWebsocketClient };
+//#region src/websocket/futures/types/user.ts
+const futuresEventRouting = {
+	listenKeyExpired: "listenKeyExpired",
+	accountUpdate: "ACCOUNT_UPDATE",
+	marginCall: "MARGIN_CALL",
+	orderTradeUpdate: "ORDER_TRADE_UPDATE",
+	tradeLite: "TRADE_LITE",
+	accountConfigUpdate: "ACCOUNT_CONFIG_UPDATE",
+	strategyUpdate: "STRATEGY_UPDATE",
+	gridUpdate: "GRID_UPDATE",
+	conditionalOrderTriggerReject: "CONDITIONAL_ORDER_TRIGGER_REJECT"
+};
+
+//#endregion
+//#region src/websocket/futures/user.ts
+const createFuturesUserWebsocketClient = async ({ baseUrl = "wss://fstream.binance.com/ws", apiKey, apiSecret }) => {
+	let socket;
+	const futuresRestClient = new FuturesRestClient({
+		apiKey,
+		apiSecret
+	});
+	let connectionController = new AbortController();
+	let listenKeyUpdateInterval;
+	const emitter = createEmitter();
+	const invertedRouting = Object.fromEntries(Object.entries(futuresEventRouting).map(([key, value]) => [value, key]));
+	const parseMessageEvent = (e) => {
+		if (typeof e.data !== "string") return;
+		const data = JSON.parse(e.data);
+		const routedEvent = invertedRouting[data.e];
+		emitter.emit(routedEvent, data);
+	};
+	const on = (method, callback, options) => {
+		emitter.on(method, callback, options);
+	};
+	const off = (method, callback) => {
+		emitter.off(method, callback);
+	};
+	const connect = async () => {
+		return new Promise((resolve) => {
+			if (!socket || socket.readyState === WebSocket.CLOSED) {
+				clearInterval(listenKeyUpdateInterval);
+				futuresRestClient.getListenKey().then(({ listenKey: newListenKey }) => {
+					let listenKey = newListenKey;
+					let url = `${baseUrl}/${listenKey}`;
+					listenKeyUpdateInterval = setInterval(async () => {
+						listenKey = (await futuresRestClient.getListenKey()).listenKey;
+					}, 30 * 1e3 * 60);
+					connectionController.abort();
+					socket = new WebSocket(url);
+					connectionController = new AbortController();
+					socket.addEventListener("open", () => {
+						socket.addEventListener("message", parseMessageEvent, { signal: connectionController.signal });
+						resolve();
+					}, { once: true });
+				});
+				return;
+			}
+			if (socket.readyState === WebSocket.OPEN) return resolve();
+			if (socket.readyState === WebSocket.CONNECTING) socket.addEventListener("open", () => {
+				socket.addEventListener("message", parseMessageEvent, { signal: connectionController.signal });
+				resolve();
+			}, { once: true });
+			if (socket.readyState === WebSocket.CLOSING) socket.addEventListener("close", async () => {
+				await connect();
+				resolve();
+			}, { once: true });
+		});
+	};
+	await connect();
+	return new Proxy({}, { get(_target, method) {
+		return Object.freeze({
+			on: (callback, options) => {
+				on(method, callback, options);
+			},
+			off: (callback) => {
+				off(method, callback);
+			}
+		});
+	} });
+};
+
+//#endregion
+export { ApiError, BinanceRestClient, ErrorMessageParsingError, MalformedParamError, ResponseError, WeightError, createFuturesUserWebsocketClient, createFuturesWebsocketClient };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@medievalrain/binance-ts",
-	"version": "0.9.8",
+	"version": "0.11.1",
 	"description": "Binance API SDK",
 	"access": "public",
 	"type": "module",
@@ -31,13 +31,13 @@
 		"oxlint": "1.24.0",
 		"prettier": "3.6.2",
 		"ts-to-zod": "5.0.1",
-		"tsdown": "0.15.9",
+		"tsdown": "0.15.11",
 		"typescript": "5.9.3",
-		"vitest": "4.0.1",
+		"vitest": "4.0.4",
 		"zod": "4.1.12"
 	},
 	"dependencies": {
-		"@medievalrain/emitter": "0.2.20"
+		"@medievalrain/emitter": "0.8.0"
 	},
 	"repository": {
 		"type": "git",