refactor: rename useDemo to demoTrading in README and codebase for clarity

Author: JJ-Cro

README.md

@@ -183,7 +183,7 @@ const demoFuturesClient = new FuturesClientV2({
   apiKey: API_KEY,
   apiSecret: API_SECRET,
   apiMemo: API_MEMO,
-  useDemo: true, // Connect to simulated trading environment
+  demoTrading: true, // Connect to simulated trading environment
 });
 
 // Get futures account assets
@@ -302,7 +302,7 @@ const demoWsClient = new WebsocketClient({
   apiKey: 'yourAPIKeyHere',
   apiSecret: 'yourAPISecretHere',
   apiMemo: 'yourAPIMemoHere',
-  useDemo: true, // Connect to simulated trading environment (V2 Futures only)
+  demoTrading: true, // Connect to simulated trading environment (V2 Futures only)
 });
 
 // Set up event handlers
@@ -347,7 +347,7 @@ For more comprehensive examples, including custom logging and error handling, ch
 
 ### Demo Trading
 
-BitMart provides a simulated trading environment for testing futures trading strategies. Enable demo mode by adding `useDemo: true` to your client configuration:
+BitMart provides a simulated trading environment for testing futures trading strategies. Enable demo mode by adding `demoTrading: true` to your client configuration:
 
 **REST API (Futures V2 only):**
 
@@ -356,7 +356,7 @@ const demoClient = new FuturesClientV2({
   apiKey: API_KEY,
   apiSecret: API_SECRET,
   apiMemo: API_MEMO,
-  useDemo: true, // Uses https://demo-api-cloud-v2.bitmart.com
+  demoTrading: true, // Uses https://demo-api-cloud-v2.bitmart.com
 });
 ```
 
@@ -367,7 +367,7 @@ const demoWsClient = new WebsocketClient({
   apiKey: API_KEY,
   apiSecret: API_SECRET,
   apiMemo: API_MEMO,
-  useDemo: true, // Uses wss://openapi-wsdemo-v2.bitmart.com
+  demoTrading: true, // Uses wss://openapi-wsdemo-v2.bitmart.com
 });
 ```
 

src/FuturesClientV2.ts

@@ -514,13 +514,13 @@ export class FuturesClientV2 extends BaseRestClient {
    * Add available funds to the futures account (Only available in the Simulated-Environment)
    *
    * Note: This endpoint is only available in the Simulated Trading environment.
-   * To use this endpoint, create a client instance with useDemo: true
+   * To use this endpoint, create a client instance with demoTrading: true
    * Example:
    *   const simulatedClient = new FuturesClientV2({
    *     apiKey: 'your-api-key',
    *     apiSecret: 'your-api-secret',
    *     apiMemo: 'your-api-memo',
-   *     useDemo: true
+   *     demoTrading: true
    *   });
    *
    * Alternatively, you can manually set baseUrl: 'https://demo-api-cloud-v2.bitmart.com'

src/WebsocketClient.ts

@@ -285,7 +285,7 @@ export class WebsocketClient extends BaseWebsocketClient<
 
     // Demo environment is only available for V2 Futures
     const networkKey =
-      this.options.useDemo &&
+      this.options.demoTrading &&
       (wsKey === WS_KEY_MAP.futuresPublicV2 ||
         wsKey === WS_KEY_MAP.futuresPrivateV2)
         ? 'demo'

src/lib/requestUtils.ts

@@ -32,7 +32,7 @@ export interface RestClientOptions {
    * For V2 Futures: https://demo-api-cloud-v2.bitmart.com
    * Note: The API keys for Simulated-Environment and Prod-Environment are the same.
    */
-  useDemo?: boolean;
+  demoTrading?: boolean;
 
   /** Default: true. whether to try and post-process request exceptions (and throw them). */
   parseExceptions?: boolean;
@@ -101,7 +101,7 @@ export function getRestBaseUrl(
     return restInverseOptions.baseUrl;
   }
 
-  if (restInverseOptions.useDemo) {
+  if (restInverseOptions.demoTrading) {
     // Demo environment is only available for V2 Futures
     if (restClientType === REST_CLIENT_TYPE_ENUM.mainV2) {
       return exchangeBaseUrls.demoV2;

src/types/websockets/client.ts

@@ -42,7 +42,7 @@ export interface WSClientConfigurableOptions {
    * For V2 Futures WebSocket: wss://openapi-wsdemo-v2.bitmart.com
    * Note: The API keys for Simulated-Environment and Prod-Environment are the same.
    */
-  useDemo?: boolean;
+  demoTrading?: boolean;
 
   /**
    * Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method