Merge pull request #922 from ccxt/ts-support

chore: full refactor towards class-based await/async + TS + ESM

Author: carlosmiei

.eslintrc.json

@@ -23,7 +23,21 @@ jobs:
         cache: 'npm'
     - name: Install npm dependencies
       run: npm i --include=dev
-    - name: Static Tests
+    - name: Lint
+      run: npm run lint
+    - name: Build
+      run: npm run build
+    - name: Static Tests (TS ESM)
+      run: npm run ts-test-static
+    - name: Static Tests (JS CJS)
       run: npm run static-test
-    - name: Live Tests
-      run: npm run test
+    - name: Live Tests (TS ESM)
+      run: npm run ts-test-live
+    - name: Ws Live Tests (spot)
+      run: npm run ws-tests-spot
+    - name: Ws Live Tests (futures)
+      run: npm run ws-tests-futures
+    - name: CJS test
+      run: npm run test-cjs
+    - name: Package test
+      run: npm run package-test

.github/workflows/js.yml

@@ -36,6 +36,8 @@
 ehthumbs.db
 Thumbs.db
 
+dist/
+
 # Secrets #
 ###########
 .secret

.gitignore

@@ -0,0 +1,4 @@
+{
+    "$schema": "https://json.schemastore.org/mocharc.json",
+    "require": "tsx"
+}

.mocharc.json

@@ -0,0 +1,13 @@
+# Initally ignore all files
+*
+
+# Files to include
+!package.json
+!package-lock.json
+!LICENSE.txt
+!README.md
+
+# Folders to include
+!src/**/*
+!dist/**/*
+

.npmignore

@@ -17,9 +17,6 @@ color=blueviolet 🔵q
 
 
 
-
-
-
 # Node Binance API
 
 [![telegram](https://patrolavia.github.io/telegram-badge/chat.png)](https://t.me/nodebinanceapi) [![Yearly Downloads](https://img.shields.io/npm/dy/node-binance-api.svg)](https://www.npmjs.com/package/node-binance-api)  [![jaggedsoft on X](https://img.shields.io/twitter/follow/jaggedsoft.svg?style=social)](https://x.com/jaggedsoft)
@@ -44,7 +41,7 @@ This project is designed to help you make your own projects that interact with t
 #### Installation
 
 ```
-npm install -s node-binance-api
+npm install node-binance-api
 ```
 [![NPM](https://nodei.co/npm/node-binance-api.png?compact=true)](https://npmjs.org/package/node-binance-api)
 <!-- [![npm install node-binance-api](https://nodei.co/npm/node-binance-api.png?mini=true)](https://npmjs.org/package/node-binance-api) -->
@@ -56,6 +53,28 @@ https://t.me/nodebinanceapi
 
 **This project is powered by** <a href="https://github.com/ccxt/ccxt"><img src="https://avatars.githubusercontent.com/u/31901609" width=4% height=4%></a>
 
+Actively maintained, typed, and safe SDK for the Binance REST APIs and Websockets. Supports ESM and CJS out of the box.
+
+### Features
+- Spot, Margin, Futures and Delivery API
+- Portfolio Margin API *\*soon*\*
+- Testnet support
+- Proxy support (REST and WS)
+- Customizable HTTP headers
+- Customizable request parameters
+- RSA/ECDSA support *\*soon*\*
+- Websocket handling with automatic reconnection
+- RecvWindow and automatic timestamps generation
+- Ability to call any endpoint, even if not supported directly by the library
+- Overridable hostnames (.us, .jp, etc)
+- Verbose mode to debug http requests/responses
+
+### Upgrading to v1.0.0+
+
+The library was fully refactored to use modern and typed JavaScript/Typescript version, using the built-in await/async syntax and unifying some methods' signatures. Some important changes include the removal of callbacks as parameters of REST methods, adaptation of signatures to directly receive some important request values (symbol, orderId, ...), etc.
+
+**We highly advise you to update from 0.0.X but minor adjustments might be needed.**
+
 
 #### Getting started (ESM)
 ```javascript
@@ -70,7 +89,7 @@ async function run() {
 #### Getting started (CJS)
 ```javascript
 const Binance = require('node-binance-api');
-const binance = new Binance().options({
+const binance = new Binance({
   APIKEY: '<key>',
   APISECRET: '<secret>',
   test: true, // if you want to use the sandbox/testnet
@@ -96,12 +115,12 @@ console.info( await binance.futuresBalance() );
 
 #### Futures Limit Buy
 ```js
-console.info( await binance.futuresBuy( 'BTCUSDT', 0.1, 8222 ) );
+console.info( await binance.futuresBuy( 'LIMIT', 'BTCUSDT', 0.1, 8222 ) );
 ```
 
 #### Futures Limit Sell
 ```js
-console.info( await binance.futuresSell( 'BTCUSDT', 0.5, 11111 ) );
+console.info( await binance.futuresSell( 'LIMIT', 'BTCUSDT', 0.5, 11111 ) );
 ```
 
 #### Futures Market Buy
@@ -197,20 +216,55 @@ console.info( await binance.futuresHistoricalTrades( "XMRUSDT" ) );
 console.info( await binance.futuresLeverageBracket( "LINKUSDT" ) );
 console.info( await binance.futuresIncome() );
 console.info( await binance.futuresCancelAll( "BTCUSDT" ) );
-console.info( await binance.futuresCancel( "BTCUSDT", {orderId: "1025137386"} ) );
+console.info( await binance.futuresCancel( "BTCUSDT", "1025137386" ) );
 console.info( await binance.futuresCountdownCancelAll( "BTCUSDT", 45000 ) );
-console.info( await binance.futuresOrderStatus( "BTCUSDT", {orderId: "1025137386"} ) );
+console.info( await binance.futuresOrderStatus( "BTCUSDT", "1025137386") );
 console.info( await binance.futuresOpenOrders() );
 console.info( await binance.futuresOpenOrders( "BTCUSDT" ) );
 console.info( await binance.futuresAllOrders() );
 console.info( await binance.futuresAllOrders( "BTCUSDT" ) );
 console.info( await binance.futuresUserTrades( "BTCUSDT" ) );
 console.info( await binance.futuresGetDataStream() );
 console.info( await binance.futuresPositionMarginHistory( "TRXUSDT" ) );
-console.info( await binance.promiseRequest( 'v1/time' ) );
+console.info( await binance.futuresPublicRequest( 'v1/time' ) );
+console.info( await binance.spotPublicRequest( 'v1/time')); // call any method by providing the path
+console.info( await binance.privateFuturesRequest('v3/account')); // custom futures private call
 // Batch orders, remaining WebSocket streams, and better documentation will be come later
 ```
 
+### Proxy support
+
+In some specific cases using a proxy is required, for example:
+- Exchange is not available in your location
+- You need to make a large amount of requests without getting blocked
+- ...
+
+This package supports the following proxy types, `httpsProxy`, `proxyUrl` and `socksProxy`
+
+#### httpsProxy
+
+To set a real http(s) proxy for your scripts, you need to have an access to a remote http or https proxy, so calls will be made directly to the target exchange, tunneled through your proxy server:
+
+```Js
+client.httpsProxy = 'http://1.2.3.4:8080/';
+```
+
+#### proxyUrl
+
+This property prepends an url to API requests. It might be useful for simple redirection or bypassing CORS browser restriction.
+
+```Js
+client.proxyUrl = 'YOUR_PROXY_URL';
+```
+
+#### socksProxy
+
+Tou can also use socks proxy with the following format:
+
+```Js
+client.socksProxy = 'socks5://1.2.3.4:8080/';
+```
+
 #### Futures Historical Bulk Data Download API
 
 ##### Get Download ID
@@ -296,6 +350,8 @@ binance.futuresTerminate( 'btcusdt@kline_4h' );
 console.log( binance.futuresSubscriptions() );
 ```
 
+
+
 # Delivery API (Futures w/Expiration Date)
 ```
 deliveryBuy