Merge pull request #12 from binance/rc-v0.3.5

Release v0.3.5
binance · Jan 10, 2024 · 94c587c · 94c587c
2 parents 1d3844e + d369235
commit 94c587c
Show file tree

Hide file tree

Showing 11 changed files with 65 additions and 52 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,6 @@
 node_modules
 dist
-.env
+.env
+
+# IntelliJ
+.idea
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,10 @@
 # Changelog
 
-## 0.3.4 - 2023-11-20
+## 0.3.5 - 2024-01-10
+- Add new Enums
+- Update Websocket types
+
+## 0.3.4 - 2023-11-17
 
 - Upgrade dependencies
 - Fix sentences grammar

diff --git a/README.md b/README.md
@@ -1,5 +1,6 @@
 # Binance connector in Typescript
 
+[![npm version](https://badge.fury.io/js/@binance%2Fconnector-typescript.svg)](https://badge.fury.io/js/@binance%2Fconnector-typescript)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 This library is an easy, simple and clean connector to the [Binance public API](https://github.com/binance/binance-spot-api-docs). It is divided into three distinct endpoints:

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@binance/connector-typescript",
-    "version": "0.3.4",
+    "version": "0.3.5",
     "description": "This is a lightweight library that works as a connector to the Binance public API.",
     "main": "./dist/index.js",
     "module": "./dist/index.mjs",

diff --git a/src/modules/enum.ts b/src/modules/enum.ts
@@ -515,7 +515,9 @@ export enum UnivTransferType {
     MAIN_PORTFOLIO_MARGIN = 'MAIN_PORTFOLIO_MARGIN',
     PORTFOLIO_MARGIN_MAIN = 'PORTFOLIO_MARGIN_MAIN',
     MAIN_ISOLATED_MARGIN = 'MAIN_ISOLATED_MARGIN',
-    ISOLATED_MARGIN_MAIN = 'ISOLATED_MARGIN_MAIN'
+    ISOLATED_MARGIN_MAIN = 'ISOLATED_MARGIN_MAIN',
+    MAIN_FUNDING = 'MAIN_FUNDING',
+    FUNDING_MAIN = 'FUNDING_MAIN',
 }
 
 export enum Urgency {

diff --git a/src/modules/restful/wallet/types.ts b/src/modules/restful/wallet/types.ts
@@ -341,7 +341,7 @@ export interface getUserUniversalTransferHistoryResponse {
     rows: getUserUniversalTransferHistoryRows[];
 }
 
-interface getUserUniversalTransferHistoryRows {
+export interface getUserUniversalTransferHistoryRows {
     asset: string;
     amount: string;
     type: UnivTransferType;

diff --git a/src/modules/websocket/websocketAPI/account/types.ts b/src/modules/websocket/websocketAPI/account/types.ts
@@ -1,31 +1,32 @@
 import { SelfTradePreventionMode } from '../../../enum';
 import { RestTradeTypes } from '../../../../index';
+import { sendMessageOptions } from '../../../../setters/types';
 
-export interface accountOptions {
+export interface accountOptions extends sendMessageOptions {
     recvWindow?: number;
 }
 
-export interface orderLimitOptions {
+export interface orderLimitOptions extends sendMessageOptions {
     recvWindow: number;
 }
 
-export interface orderHistoryOptions {
+export interface orderHistoryOptions extends sendMessageOptions {
     orderId?: number;
     startTime?: number;
     endTime?: number;
     limit?: number;
     recvWindow?: number;
 }
 
-export interface ocoOrderHistoryOptions {
+export interface ocoOrderHistoryOptions extends sendMessageOptions {
     fromId?: number;
     startTime?: number;
     endTime?: number;
     limit?: number;
     recvWindow?: number;
 }
 
-export interface myTradesOptions {
+export interface myTradesOptions extends sendMessageOptions {
     orderId?: number;
     startTime?: number;
     endTime?: number;
@@ -34,15 +35,15 @@ export interface myTradesOptions {
     recvWindow?: number;
 }
 
-export interface preventedMatchesOptions {
+export interface preventedMatchesOptions extends sendMessageOptions {
     preventedMatchId?: number;
     orderId?: number;
     fromPreventedMatchId?: number;
     limit?: number;
     recvWindow?: number;
 }
 
-export interface accountAllocationOptions {
+export interface accountAllocationOptions extends sendMessageOptions {
     startTime?: number;
     endTime?: number;
     fromAllocationId?: number;
@@ -51,7 +52,7 @@ export interface accountAllocationOptions {
     recvWindow?: number;
 }
 
-export interface accountAllocationResponse {
+export interface accountAllocationResponse extends sendMessageOptions {
     symbol: string,
     allocationId: number,
     allocationType: string,
@@ -68,12 +69,12 @@ export interface accountAllocationResponse {
     isAllocator: boolean
 }
 
-export interface orderHistoryResponse extends RestTradeTypes.getOrderResponse {
+export interface orderHistoryResponse extends RestTradeTypes.getOrderResponse, sendMessageOptions {
     preventedMatchId: number,
     preventedQuantity: string
 }
 
-export interface preventedMatchesResponse {
+export interface preventedMatchesResponse extends sendMessageOptions {
     symbol: string,
     preventedMatchId: number,
     takerOrderId: number,

diff --git a/src/modules/websocket/websocketAPI/market/types.ts b/src/modules/websocket/websocketAPI/market/types.ts
@@ -1,70 +1,71 @@
+import { sendMessageOptions } from '../../../../setters/types';
 import { ticker24hrResponse } from '../../../restful/market/types';
 
 export interface pingOptions {
     id?: number;
 }
 
-export interface exchangeInfoOptions {
+export interface exchangeInfoOptions extends sendMessageOptions {
     symbol?: string;
     symbols?: string[];
     permissions?: string[];
 }
 
-export interface orderbookOptions {
+export interface orderbookOptions extends sendMessageOptions {
     limit?: number;
 }
 
-export interface tradesOptions {
+export interface tradesOptions extends sendMessageOptions {
     limit?: number;
 }
 
-export interface historicalTradesOptions {
+export interface historicalTradesOptions extends sendMessageOptions {
     limit?: number;
     fromId?: number;
 }
 
-export interface aggTradesOptions {
+export interface aggTradesOptions extends sendMessageOptions {
     limit?: number;
     fromId?: number;
     startTime?: number;
     endTime?: number;
 }
 
-export interface klinesOptions {
+export interface klinesOptions extends sendMessageOptions {
     startTime?: number;
     endTime?: number;
     limit?: number;
 }
 
-export interface uiKlinesOptions {
+export interface uiKlinesOptions extends sendMessageOptions {
     startTime?: number;
     endTime?: number;
     limit?: number;
 }
 
-export interface ticker24hrOptions {
+export interface ticker24hrOptions extends sendMessageOptions {
     symbol?: string;
     symbols?: string[];
     type?: string;
 }
 
-export interface tickerOptions {
+export interface tickerOptions extends sendMessageOptions {
     symbol?: string;
     symbols?: string[];
     type?: string;
 }
 
-export interface tickerPriceOptions {
+export interface tickerPriceOptions extends sendMessageOptions {
     symbol?: string;
     symbols?: string[];
 }
 
-export interface tickerBookOptions {
+export interface tickerBookOptions extends sendMessageOptions {
     symbol?: string;
     symbols?: string[];
 }
 
-export interface Ticket24hr extends ticker24hrResponse {
+export interface Ticket24hr extends ticker24hrResponse, sendMessageOptions {
     weightedAvgPrice: string;
     lastQty: string;
 }
diff --git a/src/modules/websocket/websocketAPI/trade/types.ts b/src/modules/websocket/websocketAPI/trade/types.ts
@@ -1,3 +1,4 @@
+import { sendMessageOptions } from '../../../../setters/types';
 import { CancelRestrictions, NewOrderRespType, SelfTradePreventionMode, StopLimitTimeInForce, TimeInForce } from '../../../enum';
 import {
     cancelOcoResponse,
@@ -9,7 +10,7 @@ import {
     newOcoOrderReports
 } from '../../../restful/trade/types';
 
-export interface newOrderOptions {
+export interface newOrderOptions extends sendMessageOptions {
     timeInForce?: TimeInForce | '';
     price?: number;
     quantity?: number;
@@ -25,7 +26,7 @@ export interface newOrderOptions {
     recvWindow?: number;
 }
 
-export interface testNewOrderOptions {
+export interface testNewOrderOptions extends sendMessageOptions{
     timeInForce?: TimeInForce | '';
     price?: number;
     quantity?: number;
@@ -41,19 +42,19 @@ export interface testNewOrderOptions {
     recvWindow?: number;
 }
 
-export interface getOrderOptions {
+export interface getOrderOptions extends sendMessageOptions {
     origClientOrderId?: string;
     recvWindow?: number;
 }
 
-export interface cancelOrderOptions {
+export interface cancelOrderOptions extends sendMessageOptions {
     origClientOrderId?: string;
     newClientOrderId?: string;
     cancelRestrictions?: CancelRestrictions;
     recvWindow?: number;
 }
 
-export interface cancelReplaceOrderOptions {
+export interface cancelReplaceOrderOptions extends sendMessageOptions {
     cancelOrigClientOrderId?: string;
     cancelNewClientOrderId?: string;
     timeInForce?: TimeInForce | '';
@@ -72,16 +73,16 @@ export interface cancelReplaceOrderOptions {
     recvWindow?: number;
 }
 
-export interface openOrdersOptions {
+export interface openOrdersOptions extends sendMessageOptions {
     symbol?: string;
     recvWindow?: number;
 }
 
-export interface cancelOpenOrdersOptions {
+export interface cancelOpenOrdersOptions extends sendMessageOptions {
     recvWindow?: number;
 }
 
-export interface newOCOOrderOptions {
+export interface newOCOOrderOptions extends sendMessageOptions {
     listClientOrderId?: string;
     limitClientOrderId?: string;
     limitIcebergQty?: number;
@@ -100,22 +101,22 @@ export interface newOCOOrderOptions {
     recvWindow?: number;
 }
 
-export interface getOCOOrderOptions {
+export interface getOCOOrderOptions extends sendMessageOptions {
     orderListId?: number;
     recvWindow?: number;
 }
 
-export interface cancelOCOOrderOptions {
+export interface cancelOCOOrderOptions extends sendMessageOptions {
     listClientOrderId?: string;
     newClientOrderId?: string;
     recvWindow?: number;
 }
 
-export interface getOCOOpenOrdersOptions {
+export interface getOCOOpenOrdersOptions extends sendMessageOptions {
     recvWindow?: number;
 }
 
-export interface newOrderSOROptions {
+export interface newOrderSOROptions extends sendMessageOptions {
     timeInForce?: TimeInForce | '';
     price?: number;
     newClientOrderId?: string;
@@ -127,49 +128,49 @@ export interface newOrderSOROptions {
     recvWindow?: number;
 }
 
-export interface cancelOCOOrder extends Omit<cancelOcoResponse, 'orderReports'> {
+export interface cancelOCOOrder extends Omit<cancelOcoResponse, 'orderReports'>, sendMessageOptions {
     orderReports: cancelOcoOrder[];
 }
 
-interface cancelOcoOrder extends Omit<cancelOcoOrderReports, 'origClientOrderId' | 'stopPrice'> {
+interface cancelOcoOrder extends Omit<cancelOcoOrderReports, 'origClientOrderId' | 'stopPrice'>, sendMessageOptions {
     transactTime?: number;
     stopPrice?: string;
 }
 
-export interface cancelOpenOrder extends cancelOrderResponse {
+export interface cancelOpenOrder extends cancelOrderResponse, sendMessageOptions {
     transactTime: number;
     stopPrice: string;
     icebergQty: string;
     strategyId: number;
     strategyType: number;
 }
 
-export interface cancelOpenOCOOrder extends Omit<cancelOcoResponse, 'orderReports'> {
+export interface cancelOpenOCOOrder extends Omit<cancelOcoResponse, 'orderReports'>, sendMessageOptions {
     orderReports: orderReport[];
 }
 
-interface orderReport extends Omit<cancelOcoOrderReports, 'stopPrice'> {
+interface orderReport extends Omit<cancelOcoOrderReports, 'stopPrice'>, sendMessageOptions {
     transactTime?: number;
     stopPrice?: string;
 }
 
-export interface cancelOrder extends cancelOrderResponse {
+export interface cancelOrder extends cancelOrderResponse, sendMessageOptions {
     transactTime: number;
 }
 
-export interface CancelReplaceOrder extends Omit<cancelAnExistingOrderAndSendANewOrderResponse, 'cancelResponse'> {
+export interface CancelReplaceOrder extends Omit<cancelAnExistingOrderAndSendANewOrderResponse, 'cancelResponse'>, sendMessageOptions {
     cancelResponse: cancelResponse;
 }
 
-interface cancelResponse extends cancelAnExistingOrderAndSendANewOrderCancelresponse {
+interface cancelResponse extends cancelAnExistingOrderAndSendANewOrderCancelresponse, sendMessageOptions {
     transactTime: number;
 }
 
-export interface newOCOOrder extends Omit<newOcoResponse, 'orderReports'> {
+export interface newOCOOrder extends Omit<newOcoResponse, 'orderReports'>, sendMessageOptions {
     orderReports: orderReports[];
 }
 
-interface orderReports extends Omit<newOcoOrderReports, 'stopPrice'> {
+interface orderReports extends Omit<newOcoOrderReports, 'stopPrice'>, sendMessageOptions {
     workingTime: number;
     stopPrice?: string;
 }
diff --git a/src/websocketAPI.ts b/src/websocketAPI.ts
@@ -38,7 +38,7 @@ export class WebsocketAPI extends WebsocketFeaturesBase {
             console.error('Not connected');
             return;
         }
-        const id = options.id || randomString();
+        const id = options.id && /^[0-9a-f]{32}$/.test(options.id) ? options.id : randomString();
         delete options.id;
         const payload = {
             id,