@medievalrain/binance-ts 0.10.0 → 0.12.0

package/dist/index.d.ts

@@ -29,7 +29,7 @@ declare class BaseRestClient {
   }: {
     endpoint: string;
     params?: RawSearchParams;
-    method: "GET" | "POST" | "DELETE";
+    method: "GET" | "POST" | "DELETE" | "PUT";
   }): Promise<NoInfer<T>>;
   private sign;
   private toSearchParams;
@@ -440,6 +440,61 @@ type FuturesNewOrder = {
 type FuturesGetListenKey = {
   listenKey: string;
 };
+type FuturesOrderStatus = "NEW" | "PARTIALLY_FILLED" | "FILLED" | "CANCELED" | "EXPIRED" | "EXPIRED_IN_MATCH";
+type FuturesModifyOrder = {
+  orderId: number;
+  symbol: string;
+  pair: string;
+  status?: FuturesOrderStatus;
+  clientOrderId: string;
+  price: string;
+  avgPrice: string;
+  origQty: string;
+  executedQty: string;
+  cumQty: string;
+  cumBase: string;
+  timeInForce: FuturesTimeInForce;
+  type: FuturesOrderType;
+  reduceOnly: boolean;
+  closePosition: boolean;
+  side: FuturesOrderSide;
+  positionSide: FuturesPositionSide;
+  stopPrice: string;
+  workingType: FuturesWorkingType;
+  priceProtect: boolean;
+  origType: FuturesOrderType;
+  priceMatch: FuturesPriceMatch;
+  selfTradePreventionMode: FuturesSelfTradePrevention;
+  goodTillDate: number;
+  updateTime: number;
+};
+type FuturesCancelOrder = {
+  clientOrderId: string;
+  cumQty: string;
+  cumQuote: string;
+  executedQty: string;
+  orderId: number;
+  origQty: string;
+  origType: FuturesOrderType;
+  price: string;
+  reduceOnly: boolean;
+  side: FuturesOrderSide;
+  positionSide: FuturesPositionSide;
+  status: FuturesOrderStatus;
+  stopPrice: string;
+  closePosition: boolean;
+  symbol: string;
+  timeInForce: FuturesTimeInForce;
+  type: FuturesOrderType;
+  activatePrice?: string;
+  priceRate?: string;
+  updateTime: number;
+  workingType: FuturesWorkingType;
+  priceProtect: boolean;
+  priceMatch: FuturesPriceMatch;
+  selfTradePreventionMode: FuturesSelfTradePrevention;
+  goodTillDate: number;
+};
 //#endregion
 //#region src/rest/futures/client.d.ts
 declare class FuturesRestClient extends BaseRestClient {
@@ -643,6 +698,22 @@ declare class FuturesRestClient extends BaseRestClient {
     recvWindow?: number;
   }): Promise<FuturesNewOrder>;
   getListenKey(): Promise<FuturesGetListenKey>;
+  modifyOrder(params: {
+    orderId?: number;
+    origClientOrderId?: string;
+    symbol: string;
+    side: FuturesOrderSide;
+    quantity: number;
+    price: number;
+    priceMatch?: FuturesPriceMatch;
+    recvWindow?: number;
+  }): Promise<FuturesModifyOrder>;
+  cancelOrder(params: {
+    orderId?: number;
+    origClientOrderId?: string;
+    symbol: string;
+    recvWindow?: number;
+  }): Promise<FuturesCancelOrder>;
 }
 //#endregion
 //#region src/rest/spot/types.d.ts
@@ -795,4 +866,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, 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, 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$1 = "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$1;
+    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, type FuturesAggTradeEvent, FuturesAggregateTrade, FuturesAssetIndex, FuturesBasis, type FuturesBookDepthEvent, FuturesBookTicker, type FuturesBookTickerEvent, FuturesCancelOrder, 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, FuturesModifyOrder, FuturesNewOrder, FuturesNewOrderRespType, FuturesOpenInterest, FuturesOpenInterestPeriod, FuturesOpenInterestStats, FuturesOrderBook, FuturesOrderSide, FuturesOrderStatus, 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

@@ -398,6 +398,20 @@ var FuturesRestClient = class extends BaseRestClient {
 			endpoint: "/fapi/v1/listenKey"
 		});
 	}
+	async modifyOrder(params) {
+		return this.privateRequest({
+			method: "PUT",
+			endpoint: "/fapi/v1/order",
+			params
+		});
+	}
+	async cancelOrder(params) {
+		return this.privateRequest({
+			method: "DELETE",
+			endpoint: "/fapi/v1/order",
+			params
+		});
+	}
 };
 
 //#endregion
@@ -599,9 +613,91 @@ const symbolConverter = {
 		return `${symbol.toLowerCase()}@aggTrade`;
 	}
 };
-const createFuturesWebsocketClient = (baseUrl = "wss://stream.binance.com:9443/ws") => {
+const createFuturesWebsocketClient = (baseUrl = "wss://fstream.binance.com/ws") => {
 	return createWebsocketClient(baseUrl, symbolConverter);
 };
 
 //#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.10.0",
+	"version": "0.12.0",
 	"description": "Binance API SDK",
 	"access": "public",
 	"type": "module",
@@ -25,25 +25,24 @@
 		"typecheck": "tsc"
 	},
 	"devDependencies": {
-		"@types/node": "24.9.1",
-		"date-fns": "4.1.0",
+		"@types/node": "24.9.2",
 		"dotenv": "17.2.3",
-		"oxlint": "1.24.0",
+		"oxlint": "1.25.0",
 		"prettier": "3.6.2",
 		"ts-to-zod": "5.0.1",
-		"tsdown": "0.15.9",
+		"tsdown": "0.15.12",
 		"typescript": "5.9.3",
-		"vitest": "4.0.1",
+		"vitest": "4.0.6",
 		"zod": "4.1.12"
 	},
 	"dependencies": {
-		"@medievalrain/emitter": "0.2.20"
+		"@medievalrain/emitter": "0.8.0"
 	},
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/medievalrain/binance-ts.git"
 	},
-	"packageManager": "pnpm@10.19.0",
+	"packageManager": "pnpm@10.20.0",
 	"publishConfig": {
 		"access": "public",
 		"provenance": true