|
4 | 4 | - [About](#about) |
5 | 5 | - [Development](#development) |
6 | 6 | - [Installation](#installation) |
| 7 | +- [Release Notes](#release-notes) |
7 | 8 | - [Usage](#usage) |
8 | 9 | - [Contact](#contact) |
9 | 10 | - [Contributors](#contributors) |
@@ -47,6 +48,32 @@ Gradle Example |
47 | 48 | implementation group: 'io.github.wuhewuhe', name: 'bybit-java-api', version: '1.1.1' |
48 | 49 | ``` |
49 | 50 | Furthermore build tool, please check [sonar type central repository](https://central.sonatype.com/artifact/io.github.wuhewuhe/bybit-java-api/1.1.1) |
| 51 | + |
| 52 | +## Release-Notes |
| 53 | +### HTTP Sync & Async Request |
| 54 | +- Receive Window Parameter: Added by default (5 seconds). |
| 55 | +- Debug Mode Parameter: Added by default (false) to print request and response headers. |
| 56 | +- Base URL Setting: Allows setting to testnet or mainnet. |
| 57 | +- Log Option Interceptor Parameter: Currently supports SLF4J and OkHttp3; planning to support customized messaging in the next version. |
| 58 | +- Trade API: For create/amend/cancel single & batch orders, now supports dedicated class, map, and JSON. |
| 59 | +- Asset API: Deposit and withdrawal operations will automatically generate a transfer ID. |
| 60 | + |
| 61 | +### WebSocket |
| 62 | +- Ping Pong Interval Parameter: Added by default (20 seconds). |
| 63 | +- Max Alive Time Parameter: Only supports private channel, ranging from 30s to 600s (also supports minutes). |
| 64 | +- Log Option Interceptor for WebSocket: Currently supports SLF4J and OkHttp3; planning to support customized messaging in the next version. |
| 65 | + |
| 66 | +### Improvements |
| 67 | +- Class Mapping for POST Requests: Each POST request will have a class mapped and converted to JSON for the request body. |
| 68 | +- Enhanced Unit Tests: Added more tests for serialization and deserialization of data. |
| 69 | +- Performance Tests for WebSocket: Added tests for maximum argument limits. |
| 70 | +- POST Request Handling: Parameters not supported in query string will be reset to the body. |
| 71 | +- Security Enhancements: Secure check for signed requests implemented. |
| 72 | +### Change Log |
| 73 | +- CategoryType: Renamed from ProductType. |
| 74 | +- Deprecated useTestnet: This function is now deprecated. |
| 75 | +- Serialization Optimization: No reserialization of data before sending POST requests, using conversion instead. |
| 76 | + |
50 | 77 | ## Usage |
51 | 78 | Note: Replace placeholders (like YOUR_API_KEY, links, or other details) with the actual information. You can also customize this template to better fit the actual state and details of your Java API. |
52 | 79 | ### HttP Client Factory & Websocket Client |
@@ -193,7 +220,7 @@ System.out.println(subUser); |
193 | 220 | ```java |
194 | 221 | private final Integer pingInterval; |
195 | 222 | private final WebsocketMessageHandler messageHandler; |
196 | | -private final String maxAliveTime; // Only valid for private channel |
| 223 | +private final String maxAliveTime; // Only valid for private channel, timeunit in seconds or minutes |
197 | 224 | ``` |
198 | 225 |
|
199 | 226 | ### Websocket public channel |
|
0 commit comments