feat(v2.2.0): support demo trading

Author: JJ-Cro

README.md

@@ -178,6 +178,14 @@ const futuresClient = new FuturesClientV2({
   apiMemo: API_MEMO,
 });
 
+// Enable demo/simulated trading environment (optional)
+const demoFuturesClient = new FuturesClientV2({
+  apiKey: API_KEY,
+  apiSecret: API_SECRET,
+  apiMemo: API_MEMO,
+  useDemo: true, // Connect to simulated trading environment
+});
+
 // Get futures account assets
 try {
   const balances = await futuresClient.getFuturesAccountAssets();
@@ -289,6 +297,14 @@ const wsClient = new WebsocketClient({
   apiMemo: 'yourAPIMemoHere',
 });
 
+// Enable demo/simulated trading environment for V2 Futures WebSocket (optional)
+const demoWsClient = new WebsocketClient({
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
+  useDemo: true, // Connect to simulated trading environment (V2 Futures only)
+});
+
 // Set up event handlers
 wsClient.on('open', (data) => {
   console.log('Private WebSocket connected: ', data?.wsKey);
@@ -329,6 +345,34 @@ For more comprehensive examples, including custom logging and error handling, ch
 
 ## Configuration Options
 
+### Demo Trading
+
+BitMart provides a simulated trading environment for testing futures trading strategies. Enable demo mode by adding `useDemo: true` to your client configuration:
+
+**REST API (Futures V2 only):**
+
+```typescript
+const demoClient = new FuturesClientV2({
+  apiKey: API_KEY,
+  apiSecret: API_SECRET,
+  apiMemo: API_MEMO,
+  useDemo: true, // Uses https://demo-api-cloud-v2.bitmart.com
+});
+```
+
+**WebSocket (V2 Futures only):**
+
+```typescript
+const demoWsClient = new WebsocketClient({
+  apiKey: API_KEY,
+  apiSecret: API_SECRET,
+  apiMemo: API_MEMO,
+  useDemo: true, // Uses wss://openapi-wsdemo-v2.bitmart.com
+});
+```
+
+**Note:** Demo environment is only available for V2 Futures. Spot trading and V1 Futures will continue using production endpoints. The same API keys work for both production and demo environments.
+
 ### Recv Window
 
 The receive window parameter determines how long an API request is valid. This can be configured at two levels:

docs/endpointFunctionList.md

@@ -2,7 +2,7 @@ const { FuturesClientV2 } = require('bitmart-api');
 
   // This example shows how to call this bitmart API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitmart-api" for bitmart exchange
   // This bitmart API SDK is available on npm via "npm install bitmart-api"
-  // ENDPOINT: contract/private/position
+  // ENDPOINT: contract/private/position-v2
   // METHOD: GET
   // PUBLIC: NO
 

examples/apidoc/FuturesClientV2/getFuturesAccountPositionsV2.js

@@ -0,0 +1,21 @@
+const { FuturesClientV2 } = require('bitmart-api');
+
+  // This example shows how to call this bitmart API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitmart-api" for bitmart exchange
+  // This bitmart API SDK is available on npm via "npm install bitmart-api"
+  // ENDPOINT: contract/private/affiliate/rebate-api
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new FuturesClientV2({
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
+});
+
+client.getFuturesAffiliateRebateApi(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/FuturesClientV2/getFuturesAffiliateRebateApi.js

@@ -0,0 +1,21 @@
+const { FuturesClientV2 } = require('bitmart-api');
+
+  // This example shows how to call this bitmart API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitmart-api" for bitmart exchange
+  // This bitmart API SDK is available on npm via "npm install bitmart-api"
+  // ENDPOINT: contract/private/affiliate/rebate-user
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new FuturesClientV2({
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
+});
+
+client.getFuturesAffiliateRebateUser(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/FuturesClientV2/getFuturesAffiliateRebateUser.js

@@ -0,0 +1,21 @@
+const { FuturesClientV2 } = require('bitmart-api');
+
+  // This example shows how to call this bitmart API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitmart-api" for bitmart exchange
+  // This bitmart API SDK is available on npm via "npm install bitmart-api"
+  // ENDPOINT: contract/private/claim
+  // METHOD: POST
+  // PUBLIC: NO
+
+const client = new FuturesClientV2({
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
+});
+
+client.submitFuturesSimulatedClaim(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });