v3.0.0rc2 release (#82)

* Add and improve WebSocket callbacks (#81)

* refactor(websockets)!: remove WebSocketCallback abstraction to avoid losing data between websockets and callbacks

* style: fix code style issues

* v1.11.0 (#62)

* v1.12.0 (#66)

* v2.0.0rc1 (#71)

* 2.0.0rc2 (#74)

* version 2.0.0 (#78)

* 3.0.0rc1 release

* update date

* complete websocket callbacks

---------

Co-authored-by: Théo Martel <[email protected]>

* v3.0.0rc2 release

---------

Co-authored-by: Théo Martel <[email protected]>

Author: aisling-2

.github/workflows/java.yml

@@ -13,9 +13,9 @@ jobs:
         java-version: [ 8, 11, 17 ]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up JDK 8
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
           java-version: ${{ matrix.java-version }}
           distribution: 'adopt'

CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## 3.0.0rc2 - 2023-05-31
+
+### Added
+- Added WebSocket callbacks to `utils` directory with the aim of facilitating the transmission of various types of data from WebSocket connections (in addition to `onMessage`):  `WebSocketClosedCallback`, `WebSocketClosingCallback`, `WebSocketFailureCallback` and `WebSocketOpenCallback`.
+- New endpoints for Convert:
+  - `GET /sapi/v1/convert/exchangeInfo` to query for all convertible token pairs and its limits information.
+  - `GET /sapi/v1/convert/assetInfo` to query supported assets quantity precision information.
+  - `POST /sapi/v1/convert/getQuote` to request a quote for the provided token pairs.
+  - `POST /sapi/v1/convert/acceptQuote` to accept the offered quote by quote ID.
+  - `GET /sapi/v1/convert/orderStatus` to query order status by order ID.
+- New endpoint for Wallet:
+  - `GET /sapi/v1/asset/ledger-transfer/cloud-mining/queryByPage` to query Cloud-Mining payment and refund history.
+- New endpoint for Sub-account:
+  - `POST /sapi/v2/sub-account/subAccountApi/ipRestriction` to support master account to update IP Restriction for a sub-account API key.
+- Added Enums `DefaultUrls.MARKET_URL` and `DefaultUrls.MARKET_WS_URL` to be optionally used to retrieve market data.
+
+### Removed
+- The following endpoints was discontinued on January 13, 2023 6:00 AM UTC:
+  - `POST /sapi/v1/sub-account/subAccountApi/ipRestriction` to support master account enable and disable IP restriction for a sub-account API Key.
+  - `POST /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList` to support master account add IP list for a sub-account API Key.
+
+### Changed
+- Renamed `WebSocketCallback` to `WebSocketMessageCallback` and moved it to the `utils` directory.
+- Updated parameter type from `LinkedHashMap<String, Object>` to `Map<String, Object>` in certain methods to support various data structures implementing the Map interface.
+- Renamed Enum `DefaultUrls.TESTNET_WSS_URL` to `DefaultUrls.TESTNET_WS_URL`.
+- Improved `utils.UrlBuilder` and `utils.RequestHandler` code readability.
+
 ## 3.0.0rc1 - 2023-05-12
 
 ### Added

README.md

@@ -77,7 +77,7 @@ String result = client.createMarket().exchangeInfo();
 
 #### Trade Endpoint: Testing a new order
 ```java
-LinkedHashMap<String,Object> parameters = new LinkedHashMap<String,Object>();
+Map<String,Object> parameters = new LinkedHashMap<String,Object>();
 
 SpotClient client = new SpotClientImpl(PrivateConfig.API_KEY, PrivateConfig.SECRET_KEY);
 
@@ -117,7 +117,9 @@ wsStreamClient.closeConnection(streamID1); //closes aggTradeStream-btcusdt
 wsStreamClient.closeAllConnections();
 ```
 
-More examples are available at `test/examples/websocketstream` folder
+Different types of WebSocket callbacks are available. Please refer to the `src/test/java/examples/websocketstream/TradeStreamWithAllCallbacks.java` example file to explore their usage.
+
+More examples are available at `src/test/java/examples/websocketstream` folder.
 
 ### WebSocket API
 
@@ -144,15 +146,17 @@ wsApiClient.close();
 
 If `requestId` is empty (`""`), `null` or not sent, this library will generate a `UUID` string for it. 
 
-More examples are available at `test/examples/websocketapi` folder
+Different types of WebSocket callbacks are available. Please refer to the `src/test/java/examples/websocketapi/WsApiwithAllCallbacks.java` example file to explore their usage.
+
+More examples are available at `src/test/java/examples/websocketapi` folder.
 
 ### Testnet
 
 While `/sapi/*` endpoints don't have testnet environment yet, `/api/*` endpoints can be tested in
 [Spot Testnet](https://testnet.binance.vision/). You can use it by changing the base URL:
 
 ```java
-LinkedHashMap<String,Object> parameters = new LinkedHashMap<>();
+Map<String,Object> parameters = new LinkedHashMap<>();
 
 SpotClient client = new SpotClientImpl(PrivateConfig.TESTNET_API_KEY, PrivateConfig.TESTNET_SECRET_KEY, PrivateConfig.TESTNET_URL);
 String result = client.createMarket().time();
@@ -161,18 +165,17 @@ String result = client.createMarket().time();
 ### Base URL
 
 If `baseUrl` is not provided, it defaults to `api.binance.com`.<br/>
-It's recommended to pass in the `baseUrl` parameter, even in production as Binance provides alternative URLs
-in case of performance issues:
+It's recommended to pass in the `baseUrl` parameter, even in production as Binance provides alternative URLs:
 - `https://api1.binance.com`
 - `https://api2.binance.com`
 - `https://api3.binance.com`
+- `https://api4.binance.com`
 
 ### Optional parameters
 
-All parameters are read from a `LinkedHashMap<String,Object>` object where `String` is the
-name of the parameter and `Object` is the value of the parameter. The parameters should follow their exact naming as in the API documentation.<br>
+All parameters are read from a `Map<String, Object>` implemented data structure where `String` is the name of the parameter and `Object` is the value of the parameter. The parameters should follow their exact naming as in the API documentation.<br>
 ```java
-LinkedHashMap<String,Object> parameters = new LinkedHashMap<String,Object>();
+Map<String,Object> parameters = new LinkedHashMap<String,Object>();
 
 parameters.put("symbol","BTCUSDT");
 parameters.put("side", "SELL");
@@ -240,7 +243,7 @@ client.unsetProxy();
 logger.info(client.createMarket().time());
 ```
 
-Complete examples are available at `test/examples/proxy` folder.
+Complete examples are available at `src/test/java/examples/spot/proxy` folder.
 
 ### Logging
 This connector uses [`SLF4J`](https://www.slf4j.org/) as an abstraction layer for diverse logging frameworks.

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.github.binance</groupId>
     <artifactId>binance-connector-java</artifactId>
-    <version>3.0.0rc1</version>
+    <version>3.0.0rc2</version>
     <packaging>jar</packaging>
     <name>${project.groupId}:${project.artifactId}</name>
     <description>lightweight connector to API</description>
@@ -64,6 +64,7 @@
                 </configuration>
                 <executions>
                     <execution>
+                        <?m2e execute onConfiguration,onIncremental?>
                         <id>validate</id>
                         <phase>validate</phase>
                         <goals>

src/main/java/com/binance/connector/client/WebSocketApiClient.java

@@ -5,11 +5,15 @@
 import com.binance.connector.client.impl.websocketapi.WebSocketApiMarket;
 import com.binance.connector.client.impl.websocketapi.WebSocketApiTrade;
 import com.binance.connector.client.impl.websocketapi.WebSocketApiUserDataStream;
-import com.binance.connector.client.utils.WebSocketCallback;
+import com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback;
+import com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback;
+import com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback;
+import com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback;
+import com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback;
 
 public interface WebSocketApiClient {
-    void connect(WebSocketCallback onMessageCallback);
-    void connect(WebSocketCallback onOpenCallback, WebSocketCallback onMessageCallback, WebSocketCallback onClosingCallback, WebSocketCallback onFailureCallback);
+    void connect(WebSocketMessageCallback onMessageCallback);
+    void connect(WebSocketOpenCallback onOpenCallback, WebSocketMessageCallback onMessageCallback, WebSocketClosingCallback onClosingCallback, WebSocketClosedCallback onClosedCallback, WebSocketFailureCallback onFailureCallback);
     void close();
     WebSocketApiGeneral general();
     WebSocketApiMarket market();

src/main/java/com/binance/connector/client/WebSocketStreamClient.java

@@ -2,37 +2,43 @@
 
 import java.util.ArrayList;
 
-import com.binance.connector.client.utils.WebSocketCallback;
+import com.binance.connector.client.utils.websocketcallback.WebSocketClosedCallback;
+import com.binance.connector.client.utils.websocketcallback.WebSocketClosingCallback;
+import com.binance.connector.client.utils.websocketcallback.WebSocketFailureCallback;
+import com.binance.connector.client.utils.websocketcallback.WebSocketMessageCallback;
+import com.binance.connector.client.utils.websocketcallback.WebSocketOpenCallback;
 
 public interface WebSocketStreamClient {
-    int aggTradeStream(String symbol, WebSocketCallback callback);
-    int aggTradeStream(String symbol, WebSocketCallback onOpenCallback, WebSocketCallback onMessageCallback, WebSocketCallback onClosingCallback, WebSocketCallback onFailureCallback);
-    int tradeStream(String symbol, WebSocketCallback callback);
-    int tradeStream(String symbol, WebSocketCallback onOpenCallback, WebSocketCallback onMessageCallback, WebSocketCallback onClosingCallback, WebSocketCallback onFailureCallback);
-    int klineStream(String symbol, String interval, WebSocketCallback callback);
-    int klineStream(String symbol, String interval, WebSocketCallback onOpenCallback, WebSocketCallback onMessageCallback, WebSocketCallback onClosingCallback, WebSocketCallback onFailureCallback);
-    int miniTickerStream(String symbol, WebSocketCallback callback);
-    int miniTickerStream(String symbol, WebSocketCallback onOpenCallback, WebSocketCallback onMessageCallback, WebSocketCallback onClosingCallback, WebSocketCallback onFailureCallback);
-    int allMiniTickerStream(WebSocketCallback callback);
-    int allMiniTickerStream(WebSocketCallback onOpenCallback, WebSocketCallback onMessageCallback, WebSocketCallback onClosingCallback, WebSocketCallback onFailureCallback);
-    int symbolTicker(String symbol, WebSocketCallback callback);
-    int symbolTicker(String symbol, WebSocketCallback onOpenCallback, WebSocketCallback onMessageCallback, WebSocketCallback onClosingCallback, WebSocketCallback onFailureCallback);
-    int allTickerStream(WebSocketCallback callback);
-    int allTickerStream(WebSocketCallback onOpenCallback, WebSocketCallback onMessageCallback, WebSocketCallback onClosingCallback, WebSocketCallback onFailureCallback);
-    int rollingWindowTicker(String symbol, String windowSize, WebSocketCallback callback);
-    int rollingWindowTicker(String symbol, String windowSize, WebSocketCallback onOpenCallback, WebSocketCallback onMessageCallback, WebSocketCallback onClosingCallback, WebSocketCallback onFailureCallback);
-    int allRollingWindowTicker(String windowSize, WebSocketCallback callback);
-    int allRollingWindowTicker(String windowSize, WebSocketCallback onOpenCallback, WebSocketCallback onMessageCallback, WebSocketCallback onClosingCallback, WebSocketCallback onFailureCallback);
-    int bookTicker(String symbol, WebSocketCallback callback);
-    int bookTicker(String symbol, WebSocketCallback onOpenCallback, WebSocketCallback onMessageCallback, WebSocketCallback onClosingCallback, WebSocketCallback onFailureCallback);
-    int partialDepthStream(String symbol, int levels, int speed, WebSocketCallback callback);
-    int partialDepthStream(String symbol, int levels, int speed, WebSocketCallback onOpenCallback, WebSocketCallback onMessageCallback, WebSocketCallback onClosingCallback, WebSocketCallback onFailureCallback);
-    int diffDepthStream(String symbol, int speed, WebSocketCallback callback);
-    int diffDepthStream(String symbol, int speed, WebSocketCallback onOpenCallback, WebSocketCallback onMessageCallback, WebSocketCallback onClosingCallback, WebSocketCallback onFailureCallback);
-    int listenUserStream(String listenKey, WebSocketCallback callback);
-    int listenUserStream(String listenKey, WebSocketCallback onOpenCallback, WebSocketCallback onMessageCallback, WebSocketCallback onClosingCallback, WebSocketCallback onFailureCallback);
-    int combineStreams(ArrayList<String> streams, WebSocketCallback callback);
-    int combineStreams(ArrayList<String> streams, WebSocketCallback onOpenCallback, WebSocketCallback onMessageCallback, WebSocketCallback onClosingCallback, WebSocketCallback onFailureCallback);
+    int aggTradeStream(String symbol, WebSocketMessageCallback callback);
+    int aggTradeStream(String symbol, WebSocketOpenCallback onOpenCallback, WebSocketMessageCallback onMessageCallback, WebSocketClosingCallback onClosingCallback, WebSocketClosedCallback onClosedCallback, WebSocketFailureCallback onFailureCallback);
+    int tradeStream(String symbol, WebSocketMessageCallback callback);
+    int tradeStream(String symbol, WebSocketOpenCallback onOpenCallback, WebSocketMessageCallback onMessageCallback, WebSocketClosingCallback onClosingCallback, WebSocketClosedCallback onClosedCallback, WebSocketFailureCallback onFailureCallback);
+    int klineStream(String symbol, String interval, WebSocketMessageCallback callback);
+    int klineStream(String symbol, String interval, WebSocketOpenCallback onOpenCallback, WebSocketMessageCallback onMessageCallback, WebSocketClosingCallback onClosingCallback, WebSocketClosedCallback onClosedCallback, WebSocketFailureCallback onFailureCallback);
+    int miniTickerStream(String symbol, WebSocketMessageCallback callback);
+    int miniTickerStream(String symbol, WebSocketOpenCallback onOpenCallback, WebSocketMessageCallback onMessageCallback, WebSocketClosingCallback onClosingCallback, WebSocketClosedCallback onClosedCallback, WebSocketFailureCallback onFailureCallback);
+    int allMiniTickerStream(WebSocketMessageCallback callback);
+    int allMiniTickerStream(WebSocketOpenCallback onOpenCallback, WebSocketMessageCallback onMessageCallback, WebSocketClosingCallback onClosingCallback, WebSocketClosedCallback onClosedCallback, WebSocketFailureCallback onFailureCallback);
+    int symbolTicker(String symbol, WebSocketMessageCallback callback);
+    int symbolTicker(String symbol, WebSocketOpenCallback onOpenCallback, WebSocketMessageCallback onMessageCallback, WebSocketClosingCallback onClosingCallback, WebSocketClosedCallback onClosedCallback, WebSocketFailureCallback onFailureCallback);
+    int allTickerStream(WebSocketMessageCallback callback);
+    int allTickerStream(WebSocketOpenCallback onOpenCallback, WebSocketMessageCallback onMessageCallback, WebSocketClosingCallback onClosingCallback, WebSocketClosedCallback onClosedCallback, WebSocketFailureCallback onFailureCallback);
+    int rollingWindowTicker(String symbol, String windowSize, WebSocketMessageCallback callback);
+    int rollingWindowTicker(String symbol, String windowSize, WebSocketOpenCallback onOpenCallback, WebSocketMessageCallback onMessageCallback, WebSocketClosingCallback onClosingCallback, WebSocketClosedCallback onClosedCallback, WebSocketFailureCallback onFailureCallback);
+    int allRollingWindowTicker(String windowSize, WebSocketMessageCallback callback);
+    int allRollingWindowTicker(String windowSize, WebSocketOpenCallback onOpenCallback, WebSocketMessageCallback onMessageCallback, WebSocketClosingCallback onClosingCallback, WebSocketClosedCallback onClosedCallback, WebSocketFailureCallback onFailureCallback);
+    int bookTicker(String symbol, WebSocketMessageCallback callback);
+    int bookTicker(String symbol, WebSocketOpenCallback onOpenCallback, WebSocketMessageCallback onMessageCallback, WebSocketClosingCallback onClosingCallback, WebSocketClosedCallback onClosedCallback, WebSocketFailureCallback onFailureCallback);
+    int allBookTickerStream(WebSocketMessageCallback callback);
+    int allBookTickerStream(WebSocketOpenCallback onOpenCallback, WebSocketMessageCallback onMessageCallback, WebSocketClosingCallback onClosingCallback, WebSocketClosedCallback onClosedCallback, WebSocketFailureCallback onFailureCallback);
+    int partialDepthStream(String symbol, int levels, int speed, WebSocketMessageCallback callback);
+    int partialDepthStream(String symbol, int levels, int speed, WebSocketOpenCallback onOpenCallback, WebSocketMessageCallback onMessageCallback, WebSocketClosingCallback onClosingCallback, WebSocketClosedCallback onClosedCallback, WebSocketFailureCallback onFailureCallback);
+    int diffDepthStream(String symbol, int speed, WebSocketMessageCallback callback);
+    int diffDepthStream(String symbol, int speed, WebSocketOpenCallback onOpenCallback, WebSocketMessageCallback onMessageCallback, WebSocketClosingCallback onClosingCallback, WebSocketClosedCallback onClosedCallback, WebSocketFailureCallback onFailureCallback);
+    int listenUserStream(String listenKey, WebSocketMessageCallback callback);
+    int listenUserStream(String listenKey, WebSocketOpenCallback onOpenCallback, WebSocketMessageCallback onMessageCallback, WebSocketClosingCallback onClosingCallback, WebSocketClosedCallback onClosedCallback, WebSocketFailureCallback onFailureCallback);
+    int combineStreams(ArrayList<String> streams, WebSocketMessageCallback callback);
+    int combineStreams(ArrayList<String> streams, WebSocketOpenCallback onOpenCallback, WebSocketMessageCallback onMessageCallback, WebSocketClosingCallback onClosingCallback, WebSocketClosedCallback onClosedCallback, WebSocketFailureCallback onFailureCallback);
     void closeConnection(int streamId);
     void closeAllConnections();
 }

src/main/java/com/binance/connector/client/enums/DefaultUrls.java

@@ -4,10 +4,11 @@ public final class DefaultUrls {
     public static final String PROD_URL = "https://api.binance.com";
     public static final String WS_URL = "wss://stream.binance.com:9443";
     public static final String WS_API_URL = "wss://ws-api.binance.com:443/ws-api/v3";
-    public static final String TESTNET_WS_API_URL = "wss://testnet.binance.vision/ws-api/v3";
     public static final String TESTNET_URL = "https://testnet.binance.vision";
-    public static final String TESTNET_WSS_URL = "wss://testnet.binance.vision";
-
+    public static final String TESTNET_WS_URL = "wss://testnet.binance.vision";
+    public static final String TESTNET_WS_API_URL = "wss://testnet.binance.vision/ws-api/v3";
+    public static final String MARKET_URL = "https://data-api.binance.vision";
+    public static final String MARKET_WS_URL = "wss://data-stream.binance.vision";
     private DefaultUrls() {
     }
 }