Merge branch '2.1.0' into 'master'

BitMartDeveloper · BitMartDeveloper · commit 2d09084dc3eb · 2024-09-20T09:30:12.000Z
2.1.0

See merge request exchange/code/sdk/bitmart-java-sdk-api!21
diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yml
@@ -0,0 +1,53 @@
+name: 🐛 Bug Report
+title: "[Bug] "
+description: Report a bug to help us reproduce and fix it.
+labels: [ "bug" ]
+assignees: [ "11101171" ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        <img src="https://developer-pro.bitmart.com/images/logo-light@3x-caec722f.png" alt="BitMart logo" height="90px" align="right" />
+
+        Thank you for finding the time to report the problem! We really appreciate the community efforts to improve BitMart SDK.
+
+        #### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/bitmartexchange/bitmart-java-sdk-api/issues).
+
+  - type: dropdown
+    attributes:
+      label: Module Selection
+      description: |
+        Selecting a module makes it easier to locate problems
+      multiple: false
+      options:
+        - "Http"
+        - "Websocket"
+    validations:
+      required: true
+
+  - type: textarea
+    id: code
+    attributes:
+      label: Describe the Bug
+      description:  |
+        Please describe the bug clearly and concisely, preferably with code that reproduces the bug. Code snippets should be as concise as possible, and please take the time to remove irrelevant code to help us debug effectively. We hope that you can get the same results as you by copying the code and running it, so please avoid any external data or include related imports, etc.
+      placeholder: |
+        A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    id: others
+    attributes:
+      label: Additional Supplementary Information
+      description: |
+        If you have anything else to add, please write it here.
+    validations:
+      required: false
+
+  - type: markdown
+    attributes:
+      value: >
+        Thanks for your contribution 🎉!
+   
+ 
diff --git a/.github/ISSUE_TEMPLATE/02-feature-request.yml b/.github/ISSUE_TEMPLATE/02-feature-request.yml
@@ -0,0 +1,35 @@
+name: 🚀 Feature Request
+description: Submit a request for a new feature.
+title: "[Feature] "
+labels: [ "feature" ]
+assignees: [ "11101171" ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        <img src="https://developer-pro.bitmart.com/images/logo-light@3x-caec722f.png" height="90px" align="right" />
+
+        Thank you for finding the time to propose new feature!
+
+        You could submit a request for a new BitMart SDK feature here, including but not limited to: new features or models, incomplete or unusable features, accuracy/performance not as expected, etc.
+
+        #### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/bitmartexchange/bitmart-java-sdk-api/issues).
+
+
+  - type: textarea
+    attributes:
+      label: Feature Description
+      description: A short description of your feature
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives
+      description: |
+        A description of any alternative solutions or features you've considered, if any.
+    validations:
+      required: false
+
+  - type: markdown
+    attributes:
+      value: "Thanks for your contribution 🎉!"
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Ask a question or get support
+    url: https://github.com/bitmartexchange/bitmart-java-sdk-api/discussions
+    about: Ask a question or request support for using BitMart SDK
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,21 @@
 Changelog
 =========================
 
+
+### v2.1.0 Release
+#### New Features
+- New
+  - `/contract/private/submit-tp-sl-order`
+  - `/contract/private/modify-plan-order`
+  - `/contract/private/modify-preset-plan-order`
+  - `/contract/private/modify-tp-sl-order`
+- Updated
+  - `contract/private/cancel-order` Add new request field **client_order_id**
+  - `/contract/private/cancel-plan-order` Add new request field **client_order_id**
+  - `/contract/private/current-plan-order` Add new request field **plan_type**
+
+---
+
 ### v2.0.1 Release
 #### Improvements
 - Updated examples in the readme file
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,16 @@
+# Security Policy
+
+
+## Reporting a Vulnerability
+
+We encourage responsible disclosure of security issues to BitMart and please email reports about any security issues you find to security@bitmart.com.
+
+
+After the security team receives your email, they will communicate with you in time. The security team will work to keep you informed of an issue fix.
+
+In order to reproduce and identify the issue, please include the following information along with your email:
+
+* The details of the vulnerability including how to reproduce it. Try to attach a PoC.
+* The attack scenario and what an attacker might be able to achieve with this issue.
+* Whether this vulnerability has been made public. If it is, please attach details.
+* Mark the vulnerability from BitMart sdk.
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>io.github.bitmartexchange</groupId>
     <artifactId>bitmart-java-sdk-api</artifactId>
-    <version>2.0.1</version>
+    <version>2.1.0</version>
     <packaging>jar</packaging>
     <name>${project.groupId}:${project.artifactId}</name>
     <description>A Java SDK specially used to call BitMart OpenAPI</description>
diff --git a/src/main/java/com/bitmart/api/Call.java b/src/main/java/com/bitmart/api/Call.java
@@ -21,7 +21,7 @@ public final class Call {
 
     private final CloudContext cloudContext;
     private final OkHttpClient okHttpClient;
-    private static final String USER_AGENT = "BitMart-Java-SDK-API/2.0.1";
+    private static final String USER_AGENT = "BitMart-Java-SDK-API/2.1.0";
 
     private static OkHttpClient createOkHttpClient(CloudContext cloudContext) {
         HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor();
diff --git a/src/main/java/com/bitmart/api/request/contract/prv/CancelOrderRequest.java b/src/main/java/com/bitmart/api/request/contract/prv/CancelOrderRequest.java
@@ -25,9 +25,16 @@ public class CancelOrderRequest extends CloudRequest {
     /**
      * Order ID
      */
-    @ParamKey(value = "order_id", required = true)
+    @ParamKey(value = "order_id")
     private String orderId;
 
+
+    /**
+     * Client-defined OrderId
+     */
+    @ParamKey(value = "client_order_id")
+    private String clientOrderId;
+
     /**
      * Applicable for canceling a specific contract order
      */
diff --git a/src/main/java/com/bitmart/api/request/contract/prv/CancelPlanOrderRequest.java b/src/main/java/com/bitmart/api/request/contract/prv/CancelPlanOrderRequest.java
@@ -25,9 +25,15 @@ public class CancelPlanOrderRequest extends CloudRequest {
     /**
      * Order ID
      */
-    @ParamKey(value = "order_id", required = true)
+    @ParamKey(value = "order_id")
     private String orderId;
 
+    /**
+     * Order ID
+     */
+    @ParamKey(value = "client_order_id")
+    private String clientOrderId;
+
     /**
      * Applicable for canceling a specific contract plan order
      */
diff --git a/src/main/java/com/bitmart/api/request/contract/prv/GetAllCurrentPlanOrdersRequest.java b/src/main/java/com/bitmart/api/request/contract/prv/GetAllCurrentPlanOrdersRequest.java
@@ -36,6 +36,15 @@ public class GetAllCurrentPlanOrdersRequest extends CloudRequest {
     @ParamKey("limit")
     private Integer limit;
 
+    /**
+     * Plan order type
+     *  -plan
+     *  - profit_loss
+     * default all
+     */
+    @ParamKey("plan_type")
+    private String planType;
+
     /**
      * Applicable for querying contract all plan orders
      */
diff --git a/src/main/java/com/bitmart/api/request/contract/prv/ModifyPlanOrderRequest.java b/src/main/java/com/bitmart/api/request/contract/prv/ModifyPlanOrderRequest.java
@@ -0,0 +1,68 @@
+package com.bitmart.api.request.contract.prv;
+
+import com.bitmart.api.annotations.ParamKey;
+import com.bitmart.api.request.Auth;
+import com.bitmart.api.request.CloudRequest;
+import com.bitmart.api.request.Method;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+import lombok.experimental.Accessors;
+
+
+@EqualsAndHashCode(callSuper = true)
+@Data
+@ToString
+@Accessors(chain = true)
+public class ModifyPlanOrderRequest extends CloudRequest {
+
+    /**
+     * Symbol of the contract(like BTCUSDT)
+     */
+    @ParamKey(value = "symbol", required = true)
+    private String symbol;
+
+    /**
+     * Order ID(order_id or client_order_id must give one)
+     */
+    @ParamKey(value = "order_id")
+    private String orderId;
+
+    /**
+     * Client order ID(order_id or client_order_id must give one)
+     */
+    @ParamKey(value = "client_order_id")
+    private String clientOrderId;
+
+    /**
+     * Trigger price
+     */
+    @ParamKey(value = "trigger_price", required = true)
+    private String triggerPrice;
+
+    /**
+     * Execution price for plan order, mandatory when type = limit
+     */
+    @ParamKey(value = "executive_price")
+    private String executivePrice;
+
+    /**
+     * Trigger price type
+     * -1=last_price
+     * -2=fair_price
+     */
+    @ParamKey(value = "price_type", required = true)
+    private Integer priceType;
+
+    /**
+     * Order type
+     *  -limit
+     *  -market
+     */
+    @ParamKey(value = "type", required = true)
+    private String type;
+
+    public ModifyPlanOrderRequest() {
+        super("/contract/private/modify-plan-order", Method.POST, Auth.SIGNED);
+    }
+}
diff --git a/src/main/java/com/bitmart/api/request/contract/prv/ModifyPresetPlanOrderRequest.java b/src/main/java/com/bitmart/api/request/contract/prv/ModifyPresetPlanOrderRequest.java
@@ -0,0 +1,61 @@
+package com.bitmart.api.request.contract.prv;
+
+import com.bitmart.api.annotations.ParamKey;
+import com.bitmart.api.request.Auth;
+import com.bitmart.api.request.CloudRequest;
+import com.bitmart.api.request.Method;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+import lombok.experimental.Accessors;
+
+@EqualsAndHashCode(callSuper = true)
+@Data
+@ToString
+@Accessors(chain = true)
+public class ModifyPresetPlanOrderRequest extends CloudRequest {
+
+    /**
+     * Symbol of the contract(like BTCUSDT)
+     */
+    @ParamKey(value = "symbol", required = true)
+    private String symbol;
+
+    /**
+     * Order ID
+     */
+    @ParamKey(value = "order_id", required = true)
+    private String orderId;
+
+    /**
+     * Pre-set TP price type
+     * -1=last_price(default)
+     * -2=fair_price
+     */
+    @ParamKey(value = "preset_take_profit_price_type")
+    private Integer presetTakeProfitPriceType;
+
+    /**
+     * Pre-set SL price type
+     * -1=last_price(default)
+     * -2=fair_price
+     */
+    @ParamKey(value = "preset_stop_loss_price_type")
+    private Integer presetStopLossPriceType;
+
+    /**
+     * Pre-set TP price
+     */
+    @ParamKey(value = "preset_take_profit_price")
+    private String presetTakeProfitPrice;
+
+    /**
+     * Pre-set SL price
+     */
+    @ParamKey(value = "preset_stop_loss_price")
+    private String presetStopLossPrice;
+
+    public ModifyPresetPlanOrderRequest() {
+        super("/contract/private/modify-preset-plan-order", Method.POST, Auth.SIGNED);
+    }
+}
diff --git a/src/main/java/com/bitmart/api/request/contract/prv/ModifyTpSlOrderRequest.java b/src/main/java/com/bitmart/api/request/contract/prv/ModifyTpSlOrderRequest.java
diff --git a/src/main/java/com/bitmart/api/request/contract/prv/SubmitTpSlOrderRequest.java b/src/main/java/com/bitmart/api/request/contract/prv/SubmitTpSlOrderRequest.java
diff --git a/src/test/java/com/bitmart/api/TestContract.java b/src/test/java/com/bitmart/api/TestContract.java
