Release 3.0.0

* Release 3.0.0 - Implement HTTP Proxy

* Removed unnecessary `secretKey` parameter from `UserData` classes

---------

Co-authored-by: Radu Linu <[email protected]>
Co-authored-by: Jonte <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -1,3 +1,11 @@
+## 3.0.0 - 2023-03-06
+
+### Added
+- HTTP Proxy Support
+
+### Updated
+- Removed unnecessary `secretKey` parameter from `UserData` classes
+
 ## 2.0.0 - 2023-01-12
 
 ### Fixed

README.md

@@ -119,6 +119,54 @@ output:
 ```
 INFO: {"data":"{"serverTime":1633434339494}","x-mbx-used-weight":"1","x-mbx-used-weight-1m":"1"}
 ```
+
+### Proxy
+HTTP Proxy is supported.
+
+To set it up, call `setProxy()` with `ProxyAuth` and before submitting requests to binance:
+
+```java
+CMFuturesClientImpl client = new CMFuturesClientImpl();
+Proxy proxyConn = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("127.0.0.1", 8080));
+ProxyAuth proxy = new ProxyAuth(proxyConn, null);
+
+client.setProxy(proxy);
+logger.info(client.market().time());
+```
+
+For authenticated `Proxy`, define `ProxyAuth` with [`Authenticator` from `okhttp3`](https://square.github.io/okhttp/3.x/okhttp/index.html?okhttp3/Authenticator.html):
+
+```java
+CMFuturesClientImpl client = new CMFuturesClientImpl();
+Proxy proxyConn = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("127.0.0.1", 8080));
+    Authenticator auth = new Authenticator() {
+    public Request authenticate(Route route, Response response) throws IOException {
+        if (response.request().header("Proxy-Authorization") != null) {
+            return null; // Give up, we've already failed to authenticate.
+          }
+      
+        String credential = Credentials.basic("username", "password");
+        return response.request().newBuilder().header("Proxy-Authorization", credential).build();
+        
+    }
+};
+ProxyAuth proxy = new ProxyAuth(proxyConn, auth);
+
+client.setProxy(proxy);
+logger.info(client.market().time());
+```
+
+To undo `Proxy`, use `unsetProxy()` before submitting requests to binance:
+
+```java
+client.unsetProxy();
+logger.info(client.market().time());
+```
+
+Complete examples are available to the following folders:
+- `test/java/examples/cm_futures/proxy`
+- `test/java/examples/um_futures/proxy`
+
 ### Logging
 
 `ch.qos.logback` is used for logging in this connector. The configuration xml file can be found under

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.github.binance</groupId>
     <artifactId>binance-futures-connector-java</artifactId>
-    <version>2.0.0</version>
+    <version>3.0.0</version>
     <packaging>jar</packaging>
     <name>${project.groupId}:${project.artifactId}</name>
     <description>lightweight connector to Futures API</description>

src/main/java/com/binance/connector/futures/client/impl/CMFuturesClientImpl.java

@@ -36,21 +36,21 @@ public CMFuturesClientImpl(String apiKey, String secretKey, String baseUrl) {
 
     @Override
     public CMMarket market() {
-        return new CMMarket(getProductUrl(), getBaseUrl(), getApiKey(), getShowLimitUsage());
+        return new CMMarket(getProductUrl(), getBaseUrl(), getApiKey(), getShowLimitUsage(), getProxy());
     }
 
     @Override
     public CMAccount account() {
-        return new CMAccount(getProductUrl(), getApiKey(), getSecretKey(), getShowLimitUsage());
+        return new CMAccount(getProductUrl(), getApiKey(), getSecretKey(), getShowLimitUsage(), getProxy());
     }
 
     @Override
     public CMUserData userData() {
-        return new CMUserData(getProductUrl(), getApiKey(), getSecretKey(), getShowLimitUsage());
+        return new CMUserData(getProductUrl(), getApiKey(), getShowLimitUsage(), getProxy());
     }
 
     @Override
     public CMPortfolioMargin portfolioMargin() {
-        return new CMPortfolioMargin(getProductUrl(), getApiKey(), getSecretKey(), getShowLimitUsage());
+        return new CMPortfolioMargin(getProductUrl(), getApiKey(), getSecretKey(), getShowLimitUsage(), getProxy());
     }
 }

src/main/java/com/binance/connector/futures/client/impl/FuturesClientImpl.java

@@ -1,13 +1,15 @@
 package com.binance.connector.futures.client.impl;
 
 import com.binance.connector.futures.client.FuturesClient;
+import com.binance.connector.futures.client.utils.ProxyAuth;
 
 public abstract class FuturesClientImpl implements FuturesClient {
     private final String apiKey;
     private final String secretKey;
     private final String baseUrl;
     private final String productUrl;
     private boolean showLimitUsage;
+    private ProxyAuth proxy = null;
 
     public FuturesClientImpl(String baseUrl, String product) {
         this(null, null, baseUrl, product);
@@ -53,4 +55,16 @@ public void setShowLimitUsage(boolean showLimitUsage) {
         this.showLimitUsage = showLimitUsage;
     }
 
+    public void setProxy(ProxyAuth proxy) {
+        this.proxy = proxy;
+    }
+
+    public ProxyAuth getProxy() {
+        return proxy;
+    }
+
+    public void unsetProxy() {
+        this.proxy = null;
+    }
+
 }

src/main/java/com/binance/connector/futures/client/impl/UMFuturesClientImpl.java

@@ -1,10 +1,10 @@
 package com.binance.connector.futures.client.impl;
 
 import com.binance.connector.futures.client.enums.DefaultUrls;
-import com.binance.connector.futures.client.impl.um_futures.UMMarket;
 import com.binance.connector.futures.client.impl.um_futures.UMAccount;
-import com.binance.connector.futures.client.impl.um_futures.UMUserData;
+import com.binance.connector.futures.client.impl.um_futures.UMMarket;
 import com.binance.connector.futures.client.impl.um_futures.UMPortfolioMargin;
+import com.binance.connector.futures.client.impl.um_futures.UMUserData;
 
 public class UMFuturesClientImpl extends FuturesClientImpl {
     private static String defaultBaseUrl = DefaultUrls.USDM_PROD_URL;
@@ -36,21 +36,21 @@ public UMFuturesClientImpl(String apiKey, String secretKey, String baseUrl) {
 
     @Override
     public UMMarket market() {
-        return new UMMarket(getProductUrl(), getBaseUrl(), getApiKey(), getShowLimitUsage());
+        return new UMMarket(getProductUrl(), getBaseUrl(), getApiKey(), getShowLimitUsage(), getProxy());
     }
 
     @Override
     public UMAccount account() {
-        return new UMAccount(getProductUrl(), getApiKey(), getSecretKey(), getShowLimitUsage());
+        return new UMAccount(getProductUrl(), getApiKey(), getSecretKey(), getShowLimitUsage(), getProxy());
     }
 
     @Override
     public UMUserData userData() {
-        return new UMUserData(getProductUrl(), getApiKey(), getSecretKey(), getShowLimitUsage());
+        return new UMUserData(getProductUrl(), getApiKey(), getShowLimitUsage(), getProxy());
     }
 
     @Override
     public UMPortfolioMargin portfolioMargin() {
-        return new UMPortfolioMargin(getProductUrl(), getApiKey(), getSecretKey(), getShowLimitUsage());
+        return new UMPortfolioMargin(getProductUrl(), getApiKey(), getSecretKey(), getShowLimitUsage(), getProxy());
     }
-}
+}

src/main/java/com/binance/connector/futures/client/impl/cm_futures/CMAccount.java

@@ -4,6 +4,7 @@
 import com.binance.connector.futures.client.utils.ParameterChecker;
 import java.util.LinkedHashMap;
 import com.binance.connector.futures.client.impl.futures.Account;
+import com.binance.connector.futures.client.utils.ProxyAuth;
 
 /**
  * <h2>Coin-Margined Trade Endpoints</h2>
@@ -14,8 +15,8 @@
  * Response will be returned in <i>String format</i>.
  */
 public class CMAccount extends Account {
-    public CMAccount(String productUrl, String apiKey, String secretKey, boolean showLimitUsage) {
-        super(productUrl, apiKey, secretKey, showLimitUsage);
+    public CMAccount(String productUrl, String apiKey, String secretKey, boolean showLimitUsage, ProxyAuth proxy) {
+        super(productUrl, apiKey, secretKey, showLimitUsage, proxy);
     }
 
     private final String ORDER = "/v1/order";

src/main/java/com/binance/connector/futures/client/impl/cm_futures/CMMarket.java

@@ -4,6 +4,7 @@
 import com.binance.connector.futures.client.utils.ParameterChecker;
 import java.util.LinkedHashMap;
 import com.binance.connector.futures.client.impl.futures.Market;
+import com.binance.connector.futures.client.utils.ProxyAuth;
 
 /**
  * <h2>Coin-Margined Market Endpoints</h2>
@@ -14,8 +15,8 @@
  * Response will be returned in <i>String format</i>.
  */
 public class CMMarket extends Market {
-    public CMMarket(String productUrl, String baseUrl, String apiKey, boolean showLimitUsage) {
-        super(productUrl, baseUrl, apiKey, showLimitUsage);
+    public CMMarket(String productUrl, String baseUrl, String apiKey, boolean showLimitUsage, ProxyAuth proxy) {
+        super(productUrl, baseUrl, apiKey, showLimitUsage, proxy);
     }
 
     /**

src/main/java/com/binance/connector/futures/client/impl/cm_futures/CMPortfolioMargin.java

@@ -2,6 +2,7 @@
 
 import java.util.LinkedHashMap;
 import com.binance.connector.futures.client.impl.futures.PortfolioMargin;
+import com.binance.connector.futures.client.utils.ProxyAuth;
 
 /**
  * <h2>Coin-Margined Portfolio Margin Endpoints</h2>
@@ -12,8 +13,8 @@
  * Response will be returned in <i>String format</i>.
  */
 public class CMPortfolioMargin extends PortfolioMargin {
-    public CMPortfolioMargin(String productUrl, String apiKey, String secretKey, boolean showLimitUsage) {
-        super(productUrl, apiKey, secretKey, showLimitUsage);
+    public CMPortfolioMargin(String productUrl, String apiKey, String secretKey, boolean showLimitUsage, ProxyAuth proxy) {
+        super(productUrl, apiKey, secretKey, showLimitUsage, proxy);
     }
 
     /**

src/main/java/com/binance/connector/futures/client/impl/cm_futures/CMUserData.java

@@ -1,6 +1,7 @@
 package com.binance.connector.futures.client.impl.cm_futures;
 
 import com.binance.connector.futures.client.impl.futures.UserData;
+import com.binance.connector.futures.client.utils.ProxyAuth;
 
 /**
  * <h2>Coin-Margined User Data Streams Endpoints</h2>
@@ -11,7 +12,7 @@
  * Response will be returned in <i>String format</i>.
  */
 public class CMUserData extends UserData {
-    public CMUserData(String productUrl, String apiKey, String secretKey, boolean showLimitUsage) {
-        super(productUrl, apiKey, secretKey, showLimitUsage);
+    public CMUserData(String productUrl, String apiKey, boolean showLimitUsage, ProxyAuth proxy) {
+        super(productUrl, apiKey, showLimitUsage, proxy);
     }
-}
+}