binance-connector-java

Migration Guide: Binance C2c Connector Modularization

With the transition to a modularized structure, the Binance Connector has been split into separate NPM libraries, each focusing on a distinct product (e.g., Auto Invest, Futures, etc.).

Key Changes

  1. Package Name:
    The modularised C2c Connector has been moved to a new package:

    Old: ```xml

io.github.binance binance-connector-java 3.0.5 
   **New:**
```xml
<dependency>
  <groupId>io.github.binance</groupId>
  <artifactId>binance-c2c</artifactId>
  <version>1.2.0</version>
</dependency>

2Imports:
Update your import paths.

Old:

import com.binance.connector.client.SpotClient;

New:

import com.binance.connector.client.c2c.rest.api.C2cRestApi;

  1. Configuration and Client Initialization:
    The new structure keeps the existing configuration options but modularized clients into C2cRestApi.

    Old:

SpotClient client = new SpotClientImpl(PrivateConfig.API_KEY, PrivateConfig.SECRET_KEY);
String result = client.<givenMethod>(parameters);
System.out.println(result);

New:

 ClientConfiguration clientConfiguration = AlgoRestApiUtil.getClientConfiguration();
 SignatureConfiguration signatureConfiguration = new SignatureConfiguration();
 signatureConfiguration.setApiKey("apiKey");
 signatureConfiguration.setPrivateKey("path/to/private.key");
 clientConfiguration.setSignatureConfiguration(signatureConfiguration);
 
 C2cRestApi api = new C2cRestApi(clientConfiguration);
  1. Examples and Documentation:
    Updated examples can be found in the new repository folders:
    • REST API: examples/c2c/

Migration Steps

1. Replace the maven dependency

Replace the maven dependency:

 <dependency>
     <groupId>io.github.binance</groupId>
     <artifactId>binance-connector-java</artifactId>
     <version>3.0.5</version>
 </dependency>

by:

 <dependency>
     <groupId>io.github.binance</groupId>
     <artifactId>binance-c2c</artifactId>
     <version>1.2.0</version>
 </dependency>

3. Update Import Paths

Replace all occurrences of:

import com.binance.connector.client.SpotClient;

With:

import com.binance.connector.client.c2c.rest.api.C2cRestApi;

4. Update Client Initialization

Adjust your code to use the modularized structure. For example:

Old:

SpotClient client = new SpotClientImpl(PrivateConfig.API_KEY, PrivateConfig.SECRET_KEY);

New:

 ClientConfiguration clientConfiguration = C2cRestApiUtil.getClientConfiguration();
 SignatureConfiguration signatureConfiguration = new SignatureConfiguration();
 signatureConfiguration.setApiKey("apiKey");
 signatureConfiguration.setPrivateKey("path/to/private.key");
 clientConfiguration.setSignatureConfiguration(signatureConfiguration);
 clientConfiguration.setCompression(false); //disable compression
 C2cRestApi api = new C2cRestApi(clientConfiguration);

5. Test and Verify

Run your application to ensure everything works as expected. Refer to the new documentation for any advanced features or configuration options.

Additional Notes

For more details, refer to the updated README and Examples.

This site is open source. Improve this page.