gateio-api 1.2.4 → 1.2.6

package/llms.txt

@@ -2356,42 +2356,6 @@ File: tsconfig.esm.json
   "include": ["src/**/*.*"]
 }
 
-================
-File: tsconfig.json
-================
-{
-  "compilerOptions": {
-    "allowSyntheticDefaultImports": true,
-    "baseUrl": "src",
-    "noEmitOnError": true,
-    "declaration": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": false,
-    "inlineSourceMap": false,
-    "lib": ["esnext"],
-    "listEmittedFiles": false,
-    "listFiles": false,
-    "moduleResolution": "node",
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitAny": true,
-    "noUnusedParameters": true,
-    "pretty": true,
-    "removeComments": false,
-    "resolveJsonModule": true,
-    "skipLibCheck": false,
-    "sourceMap": true,
-    "strict": true,
-    "strictNullChecks": true,
-    "types": ["node", "jest"],
-    "module": "commonjs",
-    "outDir": "dist/cjs",
-    "target": "esnext"
-  },
-  "compileOnSave": true,
-  "exclude": ["node_modules", "dist"],
-  "include": ["src/**/*.*", "test/**/*.*", ".eslintrc.cjs"]
-}
-
 ================
 File: tsconfig.linting.json
 ================
@@ -3408,6 +3372,7 @@ export interface DeliveryAccount {
     bonus_dnw: string;
     bonus_offset: string;
   };
+  enable_tiered_mm: boolean;
 }
 ⋮----
 export interface DeliveryBook {
@@ -3774,6 +3739,223 @@ export interface PartnerTransaction {
   source: string;
 }
 
+================
+File: src/types/response/wallet.ts
+================
+export interface CurrencyChain {
+  chain: string;
+  name_cn: string;
+  name_en: string;
+  contract_address: string;
+  is_disabled: number;
+  is_deposit_disabled: number;
+  is_withdraw_disabled: number;
+  decimal: string;
+}
+⋮----
+export interface CreateDepositAddressResp {
+  currency: string;
+  address: string;
+  multichain_addresses: {
+    chain: string;
+    address: string;
+    payment_id: string;
+    payment_name: string;
+    obtain_failed: number;
+  }[];
+}
+⋮----
+export interface SubAccountTransferRecord {
+  currency: string;
+  sub_account: string;
+  direction: 'to' | 'from';
+  amount: string;
+  uid: string;
+  client_order_id: string;
+  timest: string;
+  source: string;
+  sub_account_type: 'spot' | 'futures' | 'cross_margin' | 'delivery';
+}
+⋮----
+export interface WithdrawalStatus {
+  currency: string;
+  name: string;
+  name_cn: string;
+  deposit: string;
+  withdraw_percent: string;
+  withdraw_fix: string;
+  withdraw_day_limit: string;
+  withdraw_amount_mini: string;
+  withdraw_day_limit_remain: string;
+  withdraw_eachtime_limit: string;
+  withdraw_fix_on_chains: { [key: string]: string };
+  withdraw_percent_on_chains: { [key: string]: string };
+}
+⋮----
+export interface SubAccountMarginBalance {
+  currency_pair: string;
+  locked: boolean;
+  risk: string;
+  base: {
+    currency: string;
+    available: string;
+    locked: string;
+    borrowed: string;
+    interest: string;
+  };
+  quote: {
+    currency: string;
+    available: string;
+    locked: string;
+    borrowed: string;
+    interest: string;
+  };
+}
+⋮----
+export interface SubAccountFuturesBalancesResp {
+  uid: string;
+  available: {
+    [key: string]: {
+      total: string;
+      unrealised_pnl: string;
+      position_margin: string;
+      order_margin: string;
+      available: string;
+      point: string;
+      currency: string;
+      in_dual_mode: boolean;
+      enable_credit: boolean;
+      position_initial_margin: string;
+      maintenance_margin: string;
+      bonus: string;
+      enable_evolved_classic: boolean;
+      cross_order_margin: string;
+      cross_initial_margin: string;
+      cross_maintenance_margin: string;
+      cross_unrealised_pnl: string;
+      cross_available: string;
+      isolated_position_margin: string;
+      history: {
+        dnw: string;
+        pnl: string;
+        fee: string;
+        refr: string;
+        fund: string;
+        point_dnw: string;
+        point_fee: string;
+        point_refr: string;
+        bonus_dnw: string;
+        bonus_offset: string;
+      };
+    };
+  };
+}
+⋮----
+export interface SubAccountCrossMarginBalancesResp {
+  uid: string;
+  available: {
+    user_id: number;
+    locked: boolean;
+    balances: {
+      [key: string]: {
+        available: string;
+        freeze: string;
+        borrowed: string;
+        interest: string;
+      };
+    };
+    total: string;
+    borrowed: string;
+    borrowed_net: string;
+    net: string;
+    leverage: string;
+    interest: string;
+    risk: string;
+    total_initial_margin: string;
+    total_margin_balance: string;
+    total_maintenance_margin: string;
+    total_initial_margin_rate: string;
+    total_maintenance_margin_rate: string;
+    total_available_margin: string;
+  };
+}
+⋮----
+export interface SavedAddress {
+  currency: string;
+  chain: string;
+  address: string;
+  name: string;
+  tag: string;
+  verified: string;
+}
+⋮----
+export interface TradingFees {
+  user_id: number;
+  taker_fee: string;
+  maker_fee: string;
+  gt_discount: boolean;
+  gt_taker_fee: string;
+  gt_maker_fee: string;
+  loan_fee: string;
+  point_type: string;
+  futures_taker_fee: string;
+  futures_maker_fee: string;
+  delivery_taker_fee: string;
+  delivery_maker_fee: string;
+  debit_fee: number;
+}
+⋮----
+export interface GetBalancesResp {
+  total: {
+    amount: string;
+    currency: string;
+    unrealised_pnl?: string;
+    borrowed?: string;
+  };
+  details: {
+    [key: string]: {
+      amount: string;
+      currency: string;
+      unrealised_pnl?: string;
+      borrowed?: string;
+    };
+  };
+}
+⋮----
+export interface SmallBalanceRecord {
+  currency: string;
+  available_balance: string;
+  estimated_as_btc: string;
+  convertible_to_gt: string;
+}
+⋮----
+export interface SmallBalanceHistoryRecord {
+  id: string;
+  currency: string;
+  amount: string;
+  gt_amount: string;
+  create_time: number;
+}
+⋮----
+export interface PushOrder {
+  id: number;
+  push_uid: number;
+  receive_uid: number;
+  currency: string;
+  amount: string;
+  create_time: number;
+  status:
+    | 'CREATING'
+    | 'PENDING'
+    | 'CANCELLING'
+    | 'CANCELLED'
+    | 'REFUSING'
+    | 'REFUSED'
+    | 'RECEIVING'
+    | 'RECEIVED';
+  message: string;
+}
+
 ================
 File: src/index.ts
 ================
@@ -3786,49 +3968,45 @@ File: src/index.ts
 // Shared Types
 
 ================
-File: .gitignore
+File: .nvmrc
 ================
-!.gitkeep
-.DS_STORE
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-pids
-*.pid
-*.seed
-*.pid.lock
-node_modules/
-.npm
-.eslintcache
-.node_repl_history
-*.tgz
-.yarn-integrity
-.env
-.env.test
-.cache
-bundleReport.html
-.history/
-dist
-coverage
-localtest.sh
-repomix.sh
-
-ws-private-spot-wsapi-performance.ts
-ws-private-perp-futures-wsapi-readonly.ts
-privatetest.ts
-
-privaterepotracker
-restClientRegex.ts
-
-testfile.ts
+v22.17.0
 
 ================
-File: .nvmrc
+File: tsconfig.json
 ================
-v22.17.0
+{
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "baseUrl": ".",
+    "noEmitOnError": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": false,
+    "inlineSourceMap": false,
+    "lib": ["esnext"],
+    "listEmittedFiles": false,
+    "listFiles": false,
+    "moduleResolution": "node",
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": true,
+    "noUnusedParameters": true,
+    "pretty": true,
+    "removeComments": false,
+    "resolveJsonModule": true,
+    "skipLibCheck": false,
+    "sourceMap": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "types": ["node", "jest"],
+    "module": "commonjs",
+    "outDir": "dist/cjs",
+    "target": "esnext"
+  },
+  "compileOnSave": true,
+  "exclude": ["node_modules", "dist"],
+  "include": ["src/**/*.*", "test/**/*.*", ".eslintrc.cjs"]
+}
 
 ================
 File: examples/ws-private-spot-wsapi.ts
@@ -4070,291 +4248,74 @@ export function safeTerminateWs(
 ): boolean
 
 ================
-File: src/types/response/wallet.ts
+File: src/types/request/futures.ts
 ================
-export interface CurrencyChain {
-  chain: string;
-  name_cn: string;
-  name_en: string;
-  contract_address: string;
-  is_disabled: number;
-  is_deposit_disabled: number;
-  is_withdraw_disabled: number;
-  decimal: string;
+/**==========================================================================================================================
+ * FUTURES
+ * ==========================================================================================================================
+ */
+⋮----
+export interface GetFuturesOrderBookReq {
+  settle: 'btc' | 'usdt' | 'usd';
+  contract: string;
+  interval?: string;
+  limit?: number;
+  with_id?: boolean;
 }
 ⋮----
-export interface CreateDepositAddressResp {
-  currency: string;
-  address: string;
-  multichain_addresses: {
-    chain: string;
-    address: string;
-    payment_id: string;
-    payment_name: string;
-    obtain_failed: number;
-  }[];
+export interface GetFuturesTradesReq {
+  settle: 'btc' | 'usdt' | 'usd';
+  contract: string;
+  limit?: number;
+  offset?: number;
+  last_id?: string;
+  from?: number;
+  to?: number;
 }
 ⋮----
-export interface SubAccountTransferRecord {
-  currency: string;
-  sub_account: string;
-  direction: 'to' | 'from';
-  amount: string;
-  uid: string;
-  client_order_id: string;
-  timest: string;
-  source: string;
-  sub_account_type: 'spot' | 'futures' | 'cross_margin' | 'delivery';
+export interface GetFuturesCandlesReq {
+  settle: 'btc' | 'usdt' | 'usd';
+  contract: string;
+  from?: number;
+  to?: number;
+  limit?: number;
+  interval?: string;
 }
 ⋮----
-export interface WithdrawalStatus {
-  currency: string;
-  name: string;
-  name_cn: string;
-  deposit: string;
-  withdraw_percent: string;
-  withdraw_fix: string;
-  withdraw_day_limit: string;
-  withdraw_amount_mini: string;
-  withdraw_day_limit_remain: string;
-  withdraw_eachtime_limit: string;
-  withdraw_fix_on_chains: { [key: string]: string };
-  withdraw_percent_on_chains: { [key: string]: string };
+export interface GetFuturesStatsReq {
+  settle: 'btc' | 'usdt' | 'usd';
+  contract: string;
+  from?: number;
+  interval?: string;
+  limit?: number;
 }
 ⋮----
-export interface SubAccountMarginBalance {
-  currency_pair: string;
-  locked: boolean;
-  risk: string;
-  base: {
-    currency: string;
-    available: string;
-    locked: string;
-    borrowed: string;
-    interest: string;
-  };
-  quote: {
-    currency: string;
-    available: string;
-    locked: string;
-    borrowed: string;
-    interest: string;
-  };
+export interface GetFundingRatesReq {
+  settle: 'btc' | 'usdt' | 'usd';
+  contract: string;
+  limit?: number;
+  from?: number;
+  to?: number;
 }
 ⋮----
-export interface SubAccountFuturesBalancesResp {
-  uid: string;
-  available: {
-    [key: string]: {
-      total: string;
-      unrealised_pnl: string;
-      position_margin: string;
-      order_margin: string;
-      available: string;
-      point: string;
-      currency: string;
-      in_dual_mode: boolean;
-      enable_credit: boolean;
-      position_initial_margin: string;
-      maintenance_margin: string;
-      bonus: string;
-      enable_evolved_classic: boolean;
-      cross_order_margin: string;
-      cross_initial_margin: string;
-      cross_maintenance_margin: string;
-      cross_unrealised_pnl: string;
-      cross_available: string;
-      isolated_position_margin: string;
-      history: {
-        dnw: string;
-        pnl: string;
-        fee: string;
-        refr: string;
-        fund: string;
-        point_dnw: string;
-        point_fee: string;
-        point_refr: string;
-        bonus_dnw: string;
-        bonus_offset: string;
-      };
-    };
-  };
+export interface GetLiquidationHistoryReq {
+  settle: 'btc' | 'usdt' | 'usd';
+  contract?: string;
+  from?: number;
+  to?: number;
+  limit?: number;
 }
 ⋮----
-export interface SubAccountCrossMarginBalancesResp {
-  uid: string;
-  available: {
-    user_id: number;
-    locked: boolean;
-    balances: {
-      [key: string]: {
-        available: string;
-        freeze: string;
-        borrowed: string;
-        interest: string;
-      };
-    };
-    total: string;
-    borrowed: string;
-    borrowed_net: string;
-    net: string;
-    leverage: string;
-    interest: string;
-    risk: string;
-    total_initial_margin: string;
-    total_margin_balance: string;
-    total_maintenance_margin: string;
-    total_initial_margin_rate: string;
-    total_maintenance_margin_rate: string;
-    total_available_margin: string;
-  };
+export interface GetRiskLimitTiersReq {
+  settle: 'btc' | 'usdt' | 'usd';
+  contract: string;
+  limit?: number;
+  offset?: number;
 }
 ⋮----
-export interface SavedAddress {
-  currency: string;
-  chain: string;
-  address: string;
-  name: string;
-  tag: string;
-  verified: string;
-}
-⋮----
-export interface TradingFees {
-  user_id: number;
-  taker_fee: string;
-  maker_fee: string;
-  gt_discount: boolean;
-  gt_taker_fee: string;
-  gt_maker_fee: string;
-  loan_fee: string;
-  point_type: string;
-  futures_taker_fee: string;
-  futures_maker_fee: string;
-  delivery_taker_fee: string;
-  delivery_maker_fee: string;
-  debit_fee: number;
-}
-⋮----
-export interface GetBalancesResp {
-  total: {
-    amount: string;
-    currency: string;
-    unrealised_pnl?: string;
-    borrowed?: string;
-  };
-  details: {
-    [key: string]: {
-      amount: string;
-      currency: string;
-      unrealised_pnl?: string;
-      borrowed?: string;
-    };
-  };
-}
-⋮----
-export interface SmallBalanceRecord {
-  currency: string;
-  available_balance: string;
-  estimated_as_btc: string;
-  convertible_to_gt: string;
-}
-⋮----
-export interface SmallBalanceHistoryRecord {
-  id: string;
-  currency: string;
-  amount: string;
-  gt_amount: string;
-  create_time: number;
-}
-⋮----
-export interface PushOrder {
-  id: number;
-  push_uid: number;
-  receive_uid: number;
-  currency: string;
-  amount: string;
-  create_time: number;
-  status:
-    | 'CREATING'
-    | 'PENDING'
-    | 'CANCELLING'
-    | 'CANCELLED'
-    | 'REFUSING'
-    | 'REFUSED'
-    | 'RECEIVING'
-    | 'RECEIVED';
-  message: string;
-}
-
-================
-File: .eslintrc.cjs
-================
-// 'no-unused-vars': ['warn'],
-
-================
-File: src/types/request/futures.ts
-================
-/**==========================================================================================================================
- * FUTURES
- * ==========================================================================================================================
- */
-⋮----
-export interface GetFuturesOrderBookReq {
-  settle: 'btc' | 'usdt' | 'usd';
-  contract: string;
-  interval?: string;
-  limit?: number;
-  with_id?: boolean;
-}
-⋮----
-export interface GetFuturesTradesReq {
-  settle: 'btc' | 'usdt' | 'usd';
-  contract: string;
-  limit?: number;
-  offset?: number;
-  last_id?: string;
-  from?: number;
-  to?: number;
-}
-⋮----
-export interface GetFuturesCandlesReq {
-  settle: 'btc' | 'usdt' | 'usd';
-  contract: string;
-  from?: number;
-  to?: number;
-  limit?: number;
-  interval?: string;
-}
-⋮----
-export interface GetFuturesStatsReq {
-  settle: 'btc' | 'usdt' | 'usd';
-  contract: string;
-  from?: number;
-  interval?: string;
-  limit?: number;
-}
-⋮----
-export interface GetFundingRatesReq {
-  settle: 'btc' | 'usdt' | 'usd';
-  contract: string;
-  limit?: number;
-  from?: number;
-  to?: number;
-}
-⋮----
-export interface GetLiquidationHistoryReq {
-  settle: 'btc' | 'usdt' | 'usd';
-  contract?: string;
-  from?: number;
-  to?: number;
-  limit?: number;
-}
-⋮----
-export interface GetRiskLimitTiersReq {
-  settle: 'btc' | 'usdt' | 'usd';
-  contract: string;
-  limit?: number;
-  offset?: number;
+export interface GetRiskLimitTableReq {
+  settle: 'btc' | 'usdt' | 'usd';
+  table_id: string;
 }
 ⋮----
 export interface GetFuturesAccountBookReq {
@@ -4536,6 +4497,51 @@ size?: number; // The new order size, including the executed order size
 price?: string; // New order price
 amend_text?: string; // Custom info during amending order
 
+================
+File: .eslintrc.cjs
+================
+// 'no-unused-vars': ['warn'],
+
+================
+File: .gitignore
+================
+!.gitkeep
+.DS_STORE
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+pids
+*.pid
+*.seed
+*.pid.lock
+node_modules/
+.npm
+.eslintcache
+.node_repl_history
+*.tgz
+.yarn-integrity
+.env
+.env.test
+.cache
+bundleReport.html
+.history/
+dist
+coverage
+localtest.sh
+repomix.sh
+
+ws-private-spot-wsapi-performance.ts
+ws-private-perp-futures-wsapi-readonly.ts
+privatetest.ts
+
+privaterepotracker
+restClientRegex.ts
+
+testfile.ts
+
 ================
 File: src/types/response/unified.ts
 ================
@@ -5872,125 +5878,624 @@ export interface SpotHistoricTradeRecord {
 }
 
 ================
-File: src/lib/BaseWSClient.ts
+File: src/types/response/futures.ts
 ================
-import EventEmitter from 'events';
-import WebSocket from 'isomorphic-ws';
-⋮----
-import {
-  WebsocketClientOptions,
-  WSClientConfigurableOptions,
-} from '../types/websockets/client.js';
-import { WsOperation } from '../types/websockets/requests.js';
-import { WS_LOGGER_CATEGORY } from '../WebsocketClient.js';
-import { DefaultLogger } from './logger.js';
-import { isMessageEvent, MessageEventLike } from './requestUtils.js';
-import {
-  safeTerminateWs,
-  WsTopicRequest,
-  WsTopicRequestOrStringTopic,
-} from './websocket/websocket-util.js';
-import { WsStore } from './websocket/WsStore.js';
-import {
-  WSConnectedResult,
-  WsConnectionStateEnum,
-} from './websocket/WsStore.types.js';
+/**==========================================================================================================================
+ * FUTURES
+ * ==========================================================================================================================
+ */
 ⋮----
-interface WSClientEventMap<WsKey extends string> {
-  /** Connection opened. If this connection was previously opened and reconnected, expect the reconnected event instead */
-  open: (evt: {
-    wsKey: WsKey;
-    event: any;
-    wsUrl: string;
-    ws: WebSocket;
-  }) => void /** Reconnecting a dropped connection */;
-  reconnect: (evt: { wsKey: WsKey; event: any }) => void;
-  /** Successfully reconnected a connection that dropped */
-  reconnected: (evt: {
-    wsKey: WsKey;
-    event: any;
-    wsUrl: string;
-    ws: WebSocket;
-  }) => void;
-  /** Connection closed */
-  close: (evt: { wsKey: WsKey; event: any }) => void;
-  /** Received reply to websocket command (e.g. after subscribing to topics) */
-  response: (response: any & { wsKey: WsKey }) => void;
-  /** Received data for topic */
-  update: (response: any & { wsKey: WsKey }) => void;
-  /** Exception from ws client OR custom listeners (e.g. if you throw inside your event handler) */
-  exception: (response: any & { wsKey: WsKey }) => void;
-  error: (response: any & { wsKey: WsKey }) => void;
-  /** Confirmation that a connection successfully authenticated */
-  authenticated: (event: { wsKey: WsKey; event: any }) => void;
+export interface FuturesOrderBook {
+  id?: number;
+  current: number;
+  update: number;
+  asks: { p: string; s: number }[];
+  bids: { p: string; s: number }[];
 }
 ⋮----
-/** Connection opened. If this connection was previously opened and reconnected, expect the reconnected event instead */
-⋮----
-}) => void /** Reconnecting a dropped connection */;
-⋮----
-/** Successfully reconnected a connection that dropped */
-⋮----
-/** Connection closed */
+export interface FuturesTrade {
+  id: number;
+  create_time: number;
+  create_time_ms: number;
+  contract: string;
+  size: number;
+  price: string;
+  is_internal?: boolean;
+}
 ⋮----
-/** Received reply to websocket command (e.g. after subscribing to topics) */
+export interface FuturesCandle {
+  t: number;
+  v?: number;
+  c: string;
+  h: string;
+  l: string;
+  o: string;
+  sum: string;
+}
 ⋮----
-/** Received data for topic */
+export interface PremiumIndexKLine {
+  t: number;
+  c: string;
+  h: string;
+  l: string;
+  o: string;
+}
 ⋮----
-/** Exception from ws client OR custom listeners (e.g. if you throw inside your event handler) */
+export interface FuturesTicker {
+  contract: string;
+  last: string;
+  change_percentage: string;
+  total_size: string;
+  low_24h: string;
+  high_24h: string;
+  volume_24h: string;
+  volume_24h_btc?: string;
+  volume_24h_usd?: string;
+  volume_24h_base: string;
+  volume_24h_quote: string;
+  volume_24h_settle: string;
+  mark_price: string;
+  funding_rate: string;
+  funding_rate_indicative: string;
+  index_price: string;
+  quanto_base_rate?: string;
+  basis_rate: string;
+  basis_value: string;
+  lowest_ask: string;
+  highest_bid: string;
+  lowest_size: string;
+  highest_size: string;
+}
 ⋮----
-/** Confirmation that a connection successfully authenticated */
+export interface FuturesStats {
+  time: number;
+  lsr_taker: number;
+  lsr_account: number;
+  long_liq_size: number;
+  long_liq_amount: number;
+  long_liq_usd: number;
+  short_liq_size: number;
+  short_liq_amount: number;
+  short_liq_usd: number;
+  open_interest: number;
+  open_interest_usd: number;
+  top_lsr_account: number;
+  top_lsr_size: number;
+}
 ⋮----
-export interface EmittableEvent<TEvent = any> {
-  eventType: 'response' | 'update' | 'exception' | 'authenticated';
-  event: TEvent;
+export interface IndexConstituents {
+  index: string;
+  constituents: {
+    exchange: string;
+    symbols: string[];
+  }[];
 }
 ⋮----
-// Type safety for on and emit handlers: https://stackoverflow.com/a/61609010/880837
-export interface BaseWebsocketClient<TWSKey extends string> {
-  on<U extends keyof WSClientEventMap<TWSKey>>(
-    event: U,
-    listener: WSClientEventMap<TWSKey>[U],
-  ): this;
-
-  emit<U extends keyof WSClientEventMap<TWSKey>>(
-    event: U,
-    ...args: Parameters<WSClientEventMap<TWSKey>[U]>
-  ): boolean;
+export interface LiquidationHistoryRecord {
+  time: number;
+  contract: string;
+  size: number;
+  order_size: number;
+  order_price: string;
+  fill_price: string;
+  left: number;
 }
 ⋮----
-on<U extends keyof WSClientEventMap<TWSKey>>(
-    event: U,
-    listener: WSClientEventMap<TWSKey>[U],
-  ): this;
+export interface RiskLimitTier {
+  tier: number;
+  risk_limit: string;
+  initial_rate: string;
+  maintenance_rate: string;
+  leverage_max: string;
+  contract: string;
+}
 ⋮----
-emit<U extends keyof WSClientEventMap<TWSKey>>(
-    event: U,
-    ...args: Parameters<WSClientEventMap<TWSKey>[U]>
-  ): boolean;
+export interface FuturesAccount {
+  total: string;
+  unrealised_pnl: string;
+  position_margin: string;
+  order_margin: string;
+  available: string;
+  point: string;
+  currency: string;
+  in_dual_mode: boolean;
+  enable_credit: boolean;
+  position_initial_margin: string;
+  maintenance_margin: string;
+  bonus: string;
+  enable_evolved_classic: boolean;
+  cross_order_margin: string;
+  cross_initial_margin: string;
+  cross_maintenance_margin: string;
+  cross_unrealised_pnl: string;
+  cross_available: string;
+  cross_margin_balance: string;
+  cross_mmr: string;
+  cross_imr: string;
+  isolated_position_margin: string;
+  enable_new_dual_mode: boolean;
+  margin_mode: number;
+  history: {
+    dnw: string;
+    pnl: string;
+    fee: string;
+    refr: string;
+    fund: string;
+    point_dnw: string;
+    point_fee: string;
+    point_refr: string;
+    bonus_dnw: string;
+    bonus_offset: string;
+  };
+  enable_tiered_mm: boolean;
+}
 ⋮----
-/**
- * Users can conveniently pass topics as strings or objects (object has topic name + optional params).
- *
- * This method normalises topics into objects (object has topic name + optional params).
- */
-function getNormalisedTopicRequests(
-  wsTopicRequests: WsTopicRequestOrStringTopic<string>[],
-): WsTopicRequest<string>[]
+export interface FuturesAccountBookRecord {
+  time: number;
+  change: string;
+  balance: string;
+  type: string;
+  text: string;
+  contract?: string;
+  trade_id: string;
+  id: string;
+}
 ⋮----
-// passed as string, convert to object
+export interface FuturesOrder {
+  id?: number;
+  user?: number;
+  create_time?: number;
+  finish_time?: number;
+  finish_as?:
+    | 'filled'
+    | 'cancelled'
+    | 'liquidated'
+    | 'ioc'
+    | 'auto_deleveraged'
+    | 'reduce_only'
+    | 'position_closed'
+    | 'stp';
+  status?: 'open' | 'finished';
+  contract: string;
+  size: number;
+  iceberg?: number;
+  price?: string;
+  close?: boolean;
+  is_close?: boolean;
+  reduce_only?: boolean;
+  is_reduce_only?: boolean;
+  is_liq?: boolean;
+  tif?: 'gtc' | 'ioc' | 'poc' | 'fok';
+  left?: number;
+  fill_price?: string;
+  text?: string;
+  tkfr?: string;
+  mkfr?: string;
+  refu?: number;
+  auto_size?: 'close_long' | 'close_short';
+  stp_id?: number;
+  stp_act?: 'cn' | 'co' | 'cb' | '-';
+  amend_text?: string;
+  biz_info?: string;
+}
 ⋮----
-// already a normalised object, thanks to user
+export interface FuturesPosition {
+  user?: number;
+  contract?: string;
+  size?: number;
+  leverage?: string;
+  risk_limit?: string;
+  leverage_max?: string;
+  maintenance_rate?: string;
+  value?: string;
+  margin?: string;
+  entry_price?: string;
+  liq_price?: string;
+  mark_price?: string;
+  initial_margin?: string;
+  maintenance_margin?: string;
+  unrealised_pnl?: string;
+  realised_pnl?: string;
+  pnl_pnl?: string;
+  pnl_fund?: string;
+  pnl_fee?: string;
+  history_pnl?: string;
+  last_close_pnl?: string;
+  realised_point?: string;
+  history_point?: string;
+  adl_ranking?: number;
+  pending_orders?: number;
+  close_order?: {
+    id?: number;
+    price?: string;
+    is_liq?: boolean;
+  } | null;
+  mode?: 'single' | 'dual_long' | 'dual_short';
+  cross_leverage_limit?: string;
+  update_time?: number;
+  update_id?: number;
+  open_time?: number;
+}
 ⋮----
-/**
- * Base WebSocket abstraction layer. Handles connections, tracking each connection as a unique "WS Key"
- */
-// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
-export abstract class BaseWebsocketClient<
+export interface FuturesTradingHistoryRecord {
+  id: number;
+  create_time: number;
+  contract: string;
+  order_id: string;
+  size: number;
+  price: string;
+  role: 'taker' | 'maker';
+  text: string;
+  fee: string;
+  point_fee: string;
+  close_size: number;
+}
 ⋮----
-/**
-   * The WS connections supported by the client, each identified by a unique primary key
-   */
+export interface FuturesPositionHistoryRecord {
+  time: number;
+  contract: string;
+  side: 'long' | 'short';
+  pnl: string;
+  pnl_pnl: string;
+  pnl_fund: string;
+  pnl_fee: string;
+  text: string;
+  max_size: string;
+  first_open_time: number;
+  long_price: string;
+  short_price: string;
+  accum_size: string;
+}
+⋮----
+export interface FuturesLiquidationHistoryRecord {
+  time: number;
+  contract: string;
+  leverage: string;
+  size: number;
+  margin: string;
+  entry_price: string;
+  liq_price: string;
+  mark_price: string;
+  order_id: number;
+  order_price: string;
+  fill_price: string;
+  left: number;
+}
+export interface FuturesAutoDeleveragingHistoryRecord {
+  time: number;
+  user: number;
+  order_id: number;
+  contract: string;
+  leverage: string;
+  cross_leverage_limit: string;
+  entry_price: string;
+  fill_price: string;
+  trade_size: number;
+  position_size: number;
+}
+⋮----
+export interface DeleteFuturesBatchOrdersResp {
+  user_id: number;
+  id: string;
+  succeeded: boolean;
+  message: string;
+}
+⋮----
+export interface FuturesContract {
+  name?: string;
+  type?: 'inverse' | 'direct';
+  quanto_multiplier?: string;
+  leverage_min?: string;
+  leverage_max?: string;
+  maintenance_rate?: string;
+  mark_type?: 'internal' | 'index';
+  mark_price?: string;
+  index_price?: string;
+  last_price?: string;
+  maker_fee_rate?: string;
+  taker_fee_rate?: string;
+  order_price_round?: string;
+  mark_price_round?: string;
+  funding_rate?: string;
+  funding_interval?: number;
+  funding_next_apply?: number;
+  risk_limit_base?: string;
+  risk_limit_step?: string;
+  risk_limit_max?: string;
+  order_size_min?: number;
+  order_size_max?: number;
+  order_price_deviate?: string;
+  ref_discount_rate?: string;
+  ref_rebate_rate?: string;
+  orderbook_id?: number;
+  trade_id?: number;
+  trade_size?: number;
+  position_size?: number;
+  config_change_time?: number;
+  in_delisting?: boolean;
+  orders_limit?: number;
+  enable_bonus?: boolean;
+  enable_credit?: boolean;
+  create_time?: number;
+  funding_cap_ratio?: string;
+}
+⋮----
+export interface FuturesPriceTriggeredOrder {
+  initial: {
+    contract: string;
+    size?: number;
+    price?: string;
+    close?: boolean;
+    tif?: 'gtc' | 'ioc';
+    text?: string;
+    reduce_only?: boolean;
+    auto_size?: string;
+    is_reduce_only?: boolean;
+    is_close?: boolean;
+  };
+  trigger: {
+    strategy_type?: 0 | 1;
+    price_type?: 0 | 1 | 2;
+    price?: string;
+    rule?: 1 | 2;
+    expiration?: number;
+  };
+  id?: number;
+  user?: number;
+  create_time?: number;
+  finish_time?: number;
+  trade_id?: number;
+  status?: 'open' | 'finished' | 'inactive' | 'invalid';
+  finish_as?: 'cancelled' | 'succeeded' | 'failed' | 'expired';
+  reason?: string;
+  order_type?:
+    | 'close-long-order'
+    | 'close-short-order'
+    | 'close-long-position'
+    | 'close-short-position'
+    | 'plan-close-long-position'
+    | 'plan-close-short-position';
+  me_order_id?: number;
+}
+⋮----
+export interface FuturesDeliveryContract {
+  name?: string;
+  underlying?: string;
+  cycle?: 'WEEKLY' | 'BI-WEEKLY' | 'QUARTERLY' | 'BI-QUARTERLY';
+  type?: 'inverse' | 'direct';
+  quanto_multiplier?: string;
+  leverage_min?: string;
+  leverage_max?: string;
+  maintenance_rate?: string;
+  mark_type?: 'internal' | 'index';
+  mark_price?: string;
+  index_price?: string;
+  last_price?: string;
+  maker_fee_rate?: string;
+  taker_fee_rate?: string;
+  order_price_round?: string;
+  mark_price_round?: string;
+  basis_rate?: string;
+  basis_value?: string;
+  basis_impact_value?: string;
+  settle_price?: string;
+  settle_price_interval?: number;
+  settle_price_duration?: number;
+  expire_time?: number;
+  risk_limit_base?: string;
+  risk_limit_step?: string;
+  risk_limit_max?: string;
+  order_size_min?: number;
+  order_size_max?: number;
+  order_price_deviate?: string;
+  ref_discount_rate?: string;
+  ref_rebate_rate?: string;
+  orderbook_id?: number;
+  trade_id?: number;
+  trade_size?: number;
+  position_size?: number;
+  config_change_time?: number;
+  in_delisting?: boolean;
+  orders_limit?: number;
+}
+⋮----
+export interface BatchAmendOrderResp {
+  succeeded: boolean;
+  label?: string;
+  detail?: string;
+  id: number;
+  user: number;
+  create_time: number;
+  finish_time?: number;
+  finish_as?:
+    | 'filled'
+    | 'cancelled'
+    | 'liquidated'
+    | 'ioc'
+    | 'auto_deleveraged'
+    | 'reduce_only'
+    | 'position_closed'
+    | 'reduce_out'
+    | 'stp';
+  status: 'open' | 'finished';
+  contract: string;
+  size: number;
+  iceberg: number;
+  price: string;
+  is_close: boolean;
+  is_reduce_only: boolean;
+  is_liq: boolean;
+  tif: 'gtc' | 'ioc' | 'poc' | 'fok';
+  left: number;
+  fill_price: string;
+  text: string;
+  tkfr: string;
+  mkfr: string;
+  refu: number;
+  stp_act: 'co' | 'cn' | 'cb' | '-';
+  stp_id: number;
+}
+⋮----
+/**
+ * @deprecated - Use FuturesAccount instead
+ */
+export interface UpdateFuturesDualModeResp {
+  total: string;
+  unrealised_pnl: string;
+  position_margin: string;
+  order_margin: string;
+  available: string;
+  point: string;
+  currency: string;
+  in_dual_mode: boolean;
+  enable_credit: boolean;
+  position_initial_margin: string;
+  maintenance_margin: string;
+  bonus: string;
+  enable_evolved_classic: boolean;
+  history: {
+    dnw: string;
+    pnl: string;
+    fee: string;
+    refr: string;
+    fund: string;
+    point_dnw: string;
+    point_fee: string;
+    point_refr: string;
+    bonus_dnw: string;
+    bonus_offset: string;
+  };
+}
+⋮----
+export interface RiskLimitTableTier {
+  tier: number;
+  risk_limit: string;
+  initial_rate: string;
+  maintenance_rate: string;
+  leverage_max: string;
+  deduction: string;
+}
+
+================
+File: src/lib/BaseWSClient.ts
+================
+import EventEmitter from 'events';
+import WebSocket from 'isomorphic-ws';
+⋮----
+import {
+  WebsocketClientOptions,
+  WSClientConfigurableOptions,
+} from '../types/websockets/client.js';
+import { WsOperation } from '../types/websockets/requests.js';
+import { WS_LOGGER_CATEGORY } from '../WebsocketClient.js';
+import { DefaultLogger } from './logger.js';
+import { isMessageEvent, MessageEventLike } from './requestUtils.js';
+import {
+  safeTerminateWs,
+  WsTopicRequest,
+  WsTopicRequestOrStringTopic,
+} from './websocket/websocket-util.js';
+import { WsStore } from './websocket/WsStore.js';
+import {
+  WSConnectedResult,
+  WsConnectionStateEnum,
+} from './websocket/WsStore.types.js';
+⋮----
+interface WSClientEventMap<WsKey extends string> {
+  /** Connection opened. If this connection was previously opened and reconnected, expect the reconnected event instead */
+  open: (evt: {
+    wsKey: WsKey;
+    event: any;
+    wsUrl: string;
+    ws: WebSocket;
+  }) => void /** Reconnecting a dropped connection */;
+  reconnect: (evt: { wsKey: WsKey; event: any }) => void;
+  /** Successfully reconnected a connection that dropped */
+  reconnected: (evt: {
+    wsKey: WsKey;
+    event: any;
+    wsUrl: string;
+    ws: WebSocket;
+  }) => void;
+  /** Connection closed */
+  close: (evt: { wsKey: WsKey; event: any }) => void;
+  /** Received reply to websocket command (e.g. after subscribing to topics) */
+  response: (response: any & { wsKey: WsKey }) => void;
+  /** Received data for topic */
+  update: (response: any & { wsKey: WsKey }) => void;
+  /** Exception from ws client OR custom listeners (e.g. if you throw inside your event handler) */
+  exception: (response: any & { wsKey: WsKey }) => void;
+  error: (response: any & { wsKey: WsKey }) => void;
+  /** Confirmation that a connection successfully authenticated */
+  authenticated: (event: { wsKey: WsKey; event: any }) => void;
+}
+⋮----
+/** Connection opened. If this connection was previously opened and reconnected, expect the reconnected event instead */
+⋮----
+}) => void /** Reconnecting a dropped connection */;
+⋮----
+/** Successfully reconnected a connection that dropped */
+⋮----
+/** Connection closed */
+⋮----
+/** Received reply to websocket command (e.g. after subscribing to topics) */
+⋮----
+/** Received data for topic */
+⋮----
+/** Exception from ws client OR custom listeners (e.g. if you throw inside your event handler) */
+⋮----
+/** Confirmation that a connection successfully authenticated */
+⋮----
+export interface EmittableEvent<TEvent = any> {
+  eventType: 'response' | 'update' | 'exception' | 'authenticated';
+  event: TEvent;
+}
+⋮----
+// Type safety for on and emit handlers: https://stackoverflow.com/a/61609010/880837
+export interface BaseWebsocketClient<TWSKey extends string> {
+  on<U extends keyof WSClientEventMap<TWSKey>>(
+    event: U,
+    listener: WSClientEventMap<TWSKey>[U],
+  ): this;
+
+  emit<U extends keyof WSClientEventMap<TWSKey>>(
+    event: U,
+    ...args: Parameters<WSClientEventMap<TWSKey>[U]>
+  ): boolean;
+}
+⋮----
+on<U extends keyof WSClientEventMap<TWSKey>>(
+    event: U,
+    listener: WSClientEventMap<TWSKey>[U],
+  ): this;
+⋮----
+emit<U extends keyof WSClientEventMap<TWSKey>>(
+    event: U,
+    ...args: Parameters<WSClientEventMap<TWSKey>[U]>
+  ): boolean;
+⋮----
+/**
+ * Users can conveniently pass topics as strings or objects (object has topic name + optional params).
+ *
+ * This method normalises topics into objects (object has topic name + optional params).
+ */
+function getNormalisedTopicRequests(
+  wsTopicRequests: WsTopicRequestOrStringTopic<string>[],
+): WsTopicRequest<string>[]
+⋮----
+// passed as string, convert to object
+⋮----
+// already a normalised object, thanks to user
+⋮----
+/**
+ * Base WebSocket abstraction layer. Handles connections, tracking each connection as a unique "WS Key"
+ */
+// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
+export abstract class BaseWebsocketClient<
+⋮----
+/**
+   * The WS connections supported by the client, each identified by a unique primary key
+   */
 ⋮----
 /**
    * State store to track a list of topics (topic requests) we are expected to be subscribed to if reconnected
@@ -6238,559 +6743,70 @@ private async onWsOpen(
 ⋮----
 // Reconnect to topics known before it connected
 ⋮----
-// Request sub to public topics, if any
-⋮----
-// Request sub to private topics, if auth on connect isn't needed
-⋮----
-// If enabled, automatically reauth WS API if reconnected
-⋮----
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-⋮----
-/**
-   * Handle subscription to private topics _after_ authentication successfully completes asynchronously.
-   *
-   * Only used for exchanges that require auth before sending private topic subscription requests
-   */
-private onWsAuthenticated(
-    wsKey: TWSKey,
-    event: { isWSAPI?: boolean; WSAPIAuthChannel?: string },
-)
-⋮----
-// Resolve & cleanup deferred "auth attempt in progress" promise
-⋮----
-// Remove before continuing, in case there's more requests queued
-⋮----
-private onWsMessage(event: unknown, wsKey: TWSKey, ws: WebSocket)
-⋮----
-// any message can clear the pong timer - wouldn't get a message if the ws wasn't working
-⋮----
-// console.log(`raw event: `, { data, dataType, emittableEvents });
-⋮----
-private onWsClose(event: unknown, wsKey: TWSKey)
-⋮----
-// unintentional close, attempt recovery
-⋮----
-// clean up any pending promises for this connection
-⋮----
-// intentional close - clean up
-// clean up any pending promises for this connection
-⋮----
-// clean up any pending promises for this connection
-⋮----
-// This was an intentional close, delete all state for this connection, as if it never existed:
-⋮----
-private getWs(wsKey: TWSKey)
-⋮----
-private setWsState(wsKey: TWSKey, state: WsConnectionStateEnum)
-⋮----
-/**
-   * Promise-driven method to assert that a ws has successfully connected (will await until connection is open)
-   */
-protected async assertIsConnected(wsKey: TWSKey): Promise<unknown>
-⋮----
-// Already in progress? Await shared promise and retry
-⋮----
-// Start connection, it should automatically store/return a promise.
-⋮----
-/**
-   * Promise-driven method to assert that a ws has been successfully authenticated (will await until auth is confirmed)
-   */
-public async assertIsAuthenticated(wsKey: TWSKey): Promise<unknown>
-⋮----
-// Already in progress? Await shared promise and retry
-⋮----
-// this.logger.trace('assertIsAuthenticated(): ok');
-⋮----
-// Start authentication, it should automatically store/return a promise.
-
-================
-File: src/types/response/futures.ts
-================
-/**==========================================================================================================================
- * FUTURES
- * ==========================================================================================================================
- */
-⋮----
-export interface FuturesOrderBook {
-  id?: number;
-  current: number;
-  update: number;
-  asks: { p: string; s: number }[];
-  bids: { p: string; s: number }[];
-}
-⋮----
-export interface FuturesTrade {
-  id: number;
-  create_time: number;
-  create_time_ms: number;
-  contract: string;
-  size: number;
-  price: string;
-  is_internal?: boolean;
-}
-⋮----
-export interface FuturesCandle {
-  t: number;
-  v?: number;
-  c: string;
-  h: string;
-  l: string;
-  o: string;
-  sum: string;
-}
+// Request sub to public topics, if any
 ⋮----
-export interface PremiumIndexKLine {
-  t: number;
-  c: string;
-  h: string;
-  l: string;
-  o: string;
-}
+// Request sub to private topics, if auth on connect isn't needed
 ⋮----
-export interface FuturesTicker {
-  contract: string;
-  last: string;
-  change_percentage: string;
-  total_size: string;
-  low_24h: string;
-  high_24h: string;
-  volume_24h: string;
-  volume_24h_btc?: string;
-  volume_24h_usd?: string;
-  volume_24h_base: string;
-  volume_24h_quote: string;
-  volume_24h_settle: string;
-  mark_price: string;
-  funding_rate: string;
-  funding_rate_indicative: string;
-  index_price: string;
-  quanto_base_rate?: string;
-  basis_rate: string;
-  basis_value: string;
-  lowest_ask: string;
-  highest_bid: string;
-  lowest_size: string;
-  highest_size: string;
-}
+// If enabled, automatically reauth WS API if reconnected
 ⋮----
-export interface FuturesStats {
-  time: number;
-  lsr_taker: number;
-  lsr_account: number;
-  long_liq_size: number;
-  long_liq_amount: number;
-  long_liq_usd: number;
-  short_liq_size: number;
-  short_liq_amount: number;
-  short_liq_usd: number;
-  open_interest: number;
-  open_interest_usd: number;
-  top_lsr_account: number;
-  top_lsr_size: number;
-}
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 ⋮----
-export interface IndexConstituents {
-  index: string;
-  constituents: {
-    exchange: string;
-    symbols: string[];
-  }[];
-}
+/**
+   * Handle subscription to private topics _after_ authentication successfully completes asynchronously.
+   *
+   * Only used for exchanges that require auth before sending private topic subscription requests
+   */
+private onWsAuthenticated(
+    wsKey: TWSKey,
+    event: { isWSAPI?: boolean; WSAPIAuthChannel?: string },
+)
 ⋮----
-export interface LiquidationHistoryRecord {
-  time: number;
-  contract: string;
-  size: number;
-  order_size: number;
-  order_price: string;
-  fill_price: string;
-  left: number;
-}
+// Resolve & cleanup deferred "auth attempt in progress" promise
 ⋮----
-export interface RiskLimitTier {
-  tier: number;
-  risk_limit: string;
-  initial_rate: string;
-  maintenance_rate: string;
-  leverage_max: string;
-  contract: string;
-}
+// Remove before continuing, in case there's more requests queued
 ⋮----
-export interface FuturesAccount {
-  total: string;
-  unrealised_pnl: string;
-  position_margin: string;
-  order_margin: string;
-  available: string;
-  point: string;
-  currency: string;
-  in_dual_mode: boolean;
-  enable_credit: boolean;
-  position_initial_margin: string;
-  maintenance_margin: string;
-  bonus: string;
-  enable_evolved_classic: boolean;
-  cross_order_margin: string;
-  cross_initial_margin: string;
-  cross_maintenance_margin: string;
-  cross_unrealised_pnl: string;
-  cross_available: string;
-  cross_margin_balance: string;
-  cross_mmr: string;
-  cross_imr: string;
-  isolated_position_margin: string;
-  enable_new_dual_mode: boolean;
-  margin_mode: number;
-  history: {
-    dnw: string;
-    pnl: string;
-    fee: string;
-    refr: string;
-    fund: string;
-    point_dnw: string;
-    point_fee: string;
-    point_refr: string;
-    bonus_dnw: string;
-    bonus_offset: string;
-  };
-}
+private onWsMessage(event: unknown, wsKey: TWSKey, ws: WebSocket)
 ⋮----
-export interface FuturesAccountBookRecord {
-  time: number;
-  change: string;
-  balance: string;
-  type: string;
-  text: string;
-  contract?: string;
-  trade_id: string;
-  id: string;
-}
+// any message can clear the pong timer - wouldn't get a message if the ws wasn't working
 ⋮----
-export interface FuturesOrder {
-  id?: number;
-  user?: number;
-  create_time?: number;
-  finish_time?: number;
-  finish_as?:
-    | 'filled'
-    | 'cancelled'
-    | 'liquidated'
-    | 'ioc'
-    | 'auto_deleveraged'
-    | 'reduce_only'
-    | 'position_closed'
-    | 'stp';
-  status?: 'open' | 'finished';
-  contract: string;
-  size: number;
-  iceberg?: number;
-  price?: string;
-  close?: boolean;
-  is_close?: boolean;
-  reduce_only?: boolean;
-  is_reduce_only?: boolean;
-  is_liq?: boolean;
-  tif?: 'gtc' | 'ioc' | 'poc' | 'fok';
-  left?: number;
-  fill_price?: string;
-  text?: string;
-  tkfr?: string;
-  mkfr?: string;
-  refu?: number;
-  auto_size?: 'close_long' | 'close_short';
-  stp_id?: number;
-  stp_act?: 'cn' | 'co' | 'cb' | '-';
-  amend_text?: string;
-  biz_info?: string;
-}
+// console.log(`raw event: `, { data, dataType, emittableEvents });
 ⋮----
-export interface FuturesPosition {
-  user?: number;
-  contract?: string;
-  size?: number;
-  leverage?: string;
-  risk_limit?: string;
-  leverage_max?: string;
-  maintenance_rate?: string;
-  value?: string;
-  margin?: string;
-  entry_price?: string;
-  liq_price?: string;
-  mark_price?: string;
-  initial_margin?: string;
-  maintenance_margin?: string;
-  unrealised_pnl?: string;
-  realised_pnl?: string;
-  pnl_pnl?: string;
-  pnl_fund?: string;
-  pnl_fee?: string;
-  history_pnl?: string;
-  last_close_pnl?: string;
-  realised_point?: string;
-  history_point?: string;
-  adl_ranking?: number;
-  pending_orders?: number;
-  close_order?: {
-    id?: number;
-    price?: string;
-    is_liq?: boolean;
-  } | null;
-  mode?: 'single' | 'dual_long' | 'dual_short';
-  cross_leverage_limit?: string;
-  update_time?: number;
-  update_id?: number;
-  open_time?: number;
-}
+private onWsClose(event: unknown, wsKey: TWSKey)
 ⋮----
-export interface FuturesTradingHistoryRecord {
-  id: number;
-  create_time: number;
-  contract: string;
-  order_id: string;
-  size: number;
-  price: string;
-  role: 'taker' | 'maker';
-  text: string;
-  fee: string;
-  point_fee: string;
-  close_size: number;
-}
+// unintentional close, attempt recovery
 ⋮----
-export interface FuturesPositionHistoryRecord {
-  time: number;
-  contract: string;
-  side: 'long' | 'short';
-  pnl: string;
-  pnl_pnl: string;
-  pnl_fund: string;
-  pnl_fee: string;
-  text: string;
-  max_size: string;
-  first_open_time: number;
-  long_price: string;
-  short_price: string;
-  accum_size: string;
-}
+// clean up any pending promises for this connection
+⋮----
+// intentional close - clean up
+// clean up any pending promises for this connection
+⋮----
+// clean up any pending promises for this connection
 ⋮----
-export interface FuturesLiquidationHistoryRecord {
-  time: number;
-  contract: string;
-  leverage: string;
-  size: number;
-  margin: string;
-  entry_price: string;
-  liq_price: string;
-  mark_price: string;
-  order_id: number;
-  order_price: string;
-  fill_price: string;
-  left: number;
-}
-export interface FuturesAutoDeleveragingHistoryRecord {
-  time: number;
-  user: number;
-  order_id: number;
-  contract: string;
-  leverage: string;
-  cross_leverage_limit: string;
-  entry_price: string;
-  fill_price: string;
-  trade_size: number;
-  position_size: number;
-}
+// This was an intentional close, delete all state for this connection, as if it never existed:
 ⋮----
-export interface DeleteFuturesBatchOrdersResp {
-  user_id: number;
-  id: string;
-  succeeded: boolean;
-  message: string;
-}
+private getWs(wsKey: TWSKey)
 ⋮----
-export interface FuturesContract {
-  name?: string;
-  type?: 'inverse' | 'direct';
-  quanto_multiplier?: string;
-  leverage_min?: string;
-  leverage_max?: string;
-  maintenance_rate?: string;
-  mark_type?: 'internal' | 'index';
-  mark_price?: string;
-  index_price?: string;
-  last_price?: string;
-  maker_fee_rate?: string;
-  taker_fee_rate?: string;
-  order_price_round?: string;
-  mark_price_round?: string;
-  funding_rate?: string;
-  funding_interval?: number;
-  funding_next_apply?: number;
-  risk_limit_base?: string;
-  risk_limit_step?: string;
-  risk_limit_max?: string;
-  order_size_min?: number;
-  order_size_max?: number;
-  order_price_deviate?: string;
-  ref_discount_rate?: string;
-  ref_rebate_rate?: string;
-  orderbook_id?: number;
-  trade_id?: number;
-  trade_size?: number;
-  position_size?: number;
-  config_change_time?: number;
-  in_delisting?: boolean;
-  orders_limit?: number;
-  enable_bonus?: boolean;
-  enable_credit?: boolean;
-  create_time?: number;
-  funding_cap_ratio?: string;
-}
+private setWsState(wsKey: TWSKey, state: WsConnectionStateEnum)
 ⋮----
-export interface FuturesPriceTriggeredOrder {
-  initial: {
-    contract: string;
-    size?: number;
-    price?: string;
-    close?: boolean;
-    tif?: 'gtc' | 'ioc';
-    text?: string;
-    reduce_only?: boolean;
-    auto_size?: string;
-    is_reduce_only?: boolean;
-    is_close?: boolean;
-  };
-  trigger: {
-    strategy_type?: 0 | 1;
-    price_type?: 0 | 1 | 2;
-    price?: string;
-    rule?: 1 | 2;
-    expiration?: number;
-  };
-  id?: number;
-  user?: number;
-  create_time?: number;
-  finish_time?: number;
-  trade_id?: number;
-  status?: 'open' | 'finished' | 'inactive' | 'invalid';
-  finish_as?: 'cancelled' | 'succeeded' | 'failed' | 'expired';
-  reason?: string;
-  order_type?:
-    | 'close-long-order'
-    | 'close-short-order'
-    | 'close-long-position'
-    | 'close-short-position'
-    | 'plan-close-long-position'
-    | 'plan-close-short-position';
-  me_order_id?: number;
-}
+/**
+   * Promise-driven method to assert that a ws has successfully connected (will await until connection is open)
+   */
+protected async assertIsConnected(wsKey: TWSKey): Promise<unknown>
 ⋮----
-export interface FuturesDeliveryContract {
-  name?: string;
-  underlying?: string;
-  cycle?: 'WEEKLY' | 'BI-WEEKLY' | 'QUARTERLY' | 'BI-QUARTERLY';
-  type?: 'inverse' | 'direct';
-  quanto_multiplier?: string;
-  leverage_min?: string;
-  leverage_max?: string;
-  maintenance_rate?: string;
-  mark_type?: 'internal' | 'index';
-  mark_price?: string;
-  index_price?: string;
-  last_price?: string;
-  maker_fee_rate?: string;
-  taker_fee_rate?: string;
-  order_price_round?: string;
-  mark_price_round?: string;
-  basis_rate?: string;
-  basis_value?: string;
-  basis_impact_value?: string;
-  settle_price?: string;
-  settle_price_interval?: number;
-  settle_price_duration?: number;
-  expire_time?: number;
-  risk_limit_base?: string;
-  risk_limit_step?: string;
-  risk_limit_max?: string;
-  order_size_min?: number;
-  order_size_max?: number;
-  order_price_deviate?: string;
-  ref_discount_rate?: string;
-  ref_rebate_rate?: string;
-  orderbook_id?: number;
-  trade_id?: number;
-  trade_size?: number;
-  position_size?: number;
-  config_change_time?: number;
-  in_delisting?: boolean;
-  orders_limit?: number;
-}
+// Already in progress? Await shared promise and retry
 ⋮----
-export interface BatchAmendOrderResp {
-  succeeded: boolean;
-  label?: string;
-  detail?: string;
-  id: number;
-  user: number;
-  create_time: number;
-  finish_time?: number;
-  finish_as?:
-    | 'filled'
-    | 'cancelled'
-    | 'liquidated'
-    | 'ioc'
-    | 'auto_deleveraged'
-    | 'reduce_only'
-    | 'position_closed'
-    | 'reduce_out'
-    | 'stp';
-  status: 'open' | 'finished';
-  contract: string;
-  size: number;
-  iceberg: number;
-  price: string;
-  is_close: boolean;
-  is_reduce_only: boolean;
-  is_liq: boolean;
-  tif: 'gtc' | 'ioc' | 'poc' | 'fok';
-  left: number;
-  fill_price: string;
-  text: string;
-  tkfr: string;
-  mkfr: string;
-  refu: number;
-  stp_act: 'co' | 'cn' | 'cb' | '-';
-  stp_id: number;
-}
+// Start connection, it should automatically store/return a promise.
 ⋮----
 /**
- * @deprecated - Use FuturesAccount instead
- */
-export interface UpdateFuturesDualModeResp {
-  total: string;
-  unrealised_pnl: string;
-  position_margin: string;
-  order_margin: string;
-  available: string;
-  point: string;
-  currency: string;
-  in_dual_mode: boolean;
-  enable_credit: boolean;
-  position_initial_margin: string;
-  maintenance_margin: string;
-  bonus: string;
-  enable_evolved_classic: boolean;
-  history: {
-    dnw: string;
-    pnl: string;
-    fee: string;
-    refr: string;
-    fund: string;
-    point_dnw: string;
-    point_fee: string;
-    point_refr: string;
-    bonus_dnw: string;
-    bonus_offset: string;
-  };
-}
+   * Promise-driven method to assert that a ws has been successfully authenticated (will await until auth is confirmed)
+   */
+public async assertIsAuthenticated(wsKey: TWSKey): Promise<unknown>
+⋮----
+// Already in progress? Await shared promise and retry
+⋮----
+// this.logger.trace('assertIsAuthenticated(): ok');
+⋮----
+// Start authentication, it should automatically store/return a promise.
 
 ================
 File: src/WebsocketAPIClient.ts
@@ -7073,32 +7089,66 @@ File: README.md
 
 Updated & performant JavaScript & Node.js SDK for the Gate.com (gate.io) REST APIs and WebSockets:
 
+- Professional, robust & performant Gate.com SDK with extensive production use in live trading environments.
 - Extensive integration with Gate.com (Gate.io) REST APIs and WebSockets.
-- TypeScript support (with type declarations for most API requests & responses).
+- Complete TypeScript support (with type declarations for most API requests & responses).
+  - Strongly typed requests and responses.
+  - Automated end-to-end tests ensuring reliability.
+- Actively maintained with a modern, promise-driven interface.
 - Gate.com REST APIs for Gate.com Spot, Margin, Perpetual Futures, Delivery Futures, Options & Announcements APIs.
+  - Unified RestClient for all Gate.com trading products.
   - Strongly typed on most requests and responses.
-- Extremely robust & performant JavaScript/Node.js Gate.com SDK.
-- Actively maintained with a modern, promise-driven interface.
 - Support for seamless API authentication for private Gate.com REST API and WebSocket calls.
-- Gate.com Spot, Margin, Perpetual Futures, Delivery Futures & Options.
+- Robust WebSocket integration with configurable connection heartbeats & automatic reconnect then resubscribe workflows.
   - Event driven messaging.
-  - Smart websocket persistence
+  - Smart websocket persistence with automatic reconnection handling.
     - Automatically handle silent websocket disconnections through timed heartbeats, including the scheduled 24hr disconnect.
     - Automatically handle listenKey persistence and expiration/refresh.
     - Emit `reconnected` event when dropped connection is restored.
-- Websocket API for Gate.com Spot, Margin, Perpetual Futures & Delivery Futures.
+  - Support for Gate.com Spot, Margin, Perpetual Futures, Delivery Futures & Options.
+- WebSocket API for Gate.com Spot, Margin, Perpetual Futures & Delivery Futures.
   - Automatic connectivity via existing WebsocketClient, just call sendWSAPIRequest to trigger a request.
   - Automatic authentication, just call sendWSAPIRequest with channel & parameters.
   - Choose between two interfaces for WS API communication:
     - Event-driven interface, fire & forget via sendWSAPIRequest and receive async replies via wsClient's event emitter.
     - Promise-driven interface, simply use the WebsocketAPIClient for a REST-like experience. Use the WebSocket API like a REST API! See [examples/ws-api-client.ts](./examples/ws-api-client.ts) for a demonstration.
+- Heavy automated end-to-end testing with real API calls.
 - Proxy support via axios integration.
 - Active community support & collaboration in telegram: [Node.js Algo Traders](https://t.me/nodetraders).
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Examples](#examples)
+- [Issues & Discussion](#issues--discussion)
+- [Related Projects](#related-projects)
+- [Documentation](#documentation)
+- [Structure](#structure)
+- [Usage](#usage)
+  - [REST API Client](#rest-api)
+  - [WebSocket Client](#websockets)
+    - [WebSocket Data Streams](#websocket-data-streams)
+    - [WebSocket API](#websocket-api)
+      - [Event Driven API](#event-driven-api)
+      - [REST-like API](#rest-like-api)
+- [Customise Logging](#customise-logging)
+- [LLMs & AI](#use-with-llms--ai)
+- [Contributions & Thanks](#contributions--thanks)
+
 ## Installation
 
 `npm install --save gateio-api`
 
+## Examples
+
+Refer to the [examples](./examples) folder for implementation demos, including:
+
+- **REST API Examples**: spot trading, futures trading, account management
+- **WebSocket Examples**: public market data streams, private account data, WebSocket API usage
+- **Spot Trading**: comprehensive spot market examples
+- **Futures Trading**: perpetual and delivery futures examples
+- **WebSocket API**: both event-driven and promise-driven approaches
+
 ## Issues & Discussion
 
 - Issues? Check the [issues tab](https://github.com/tiagosiebler/gateio-api/issues).
@@ -7129,9 +7179,16 @@ Check out my related JavaScript/TypeScript/Node.js projects:
 
 ## Documentation
 
-Most methods accept JS objects. These can be populated using parameters specified by gateio's API documentation.
+Most methods accept JS objects. These can be populated using parameters specified by Gate.com's API documentation, or check the type definition in each class within this repository.
+
+### API Documentation Links
 
 - [Gate.com/gate.io API Documentation](https://www.gate.com/docs/developers/apiv4/en/)
+  - [Spot Trading API](https://www.gate.com/docs/developers/apiv4/en/#spot-new)
+  - [Margin Trading API](https://www.gate.com/docs/developers/apiv4/en/#margin-new)
+  - [Futures Trading API](https://www.gate.com/docs/developers/apiv4/en/#futures-new)
+  - [Options Trading API](https://www.gate.com/docs/developers/apiv4/en/#options-new)
+  - [WebSocket API](https://www.gate.com/docs/developers/apiv4/en/#websocket-api)
 - [REST Endpoint Function List](./docs/endpointFunctionList.md)
 - [TSDoc Documentation (autogenerated using typedoc)](https://tsdocs.dev/docs/gateio-api)
 
@@ -7146,11 +7203,13 @@ This project uses typescript. Resources are stored in 2 key structures:
 
 # Usage
 
-Create API credentials
+Create API credentials on Gate.com's website:
 
 - [Gate.com API Key Management](https://www.gate.com/myaccount/api_key_manage)
 
-### REST API
+## REST API
+
+The SDK provides a unified `RestClient` for all Gate.com trading products including Spot, Margin, Perpetual Futures, Delivery Futures, and Options. This single client handles all REST API operations across all trading markets.
 
 To use any of Gate.com's REST APIs in JavaScript/TypeScript/Node.js, import (or require) the `RestClient`:
 
@@ -7191,6 +7250,19 @@ See [RestClient](./src/RestClient.ts) for further information, or the [examples]
 
 ## WebSockets
 
+All WebSocket functionality is supported via the unified `WebsocketClient`. This client handles all Gate.com WebSocket streams with automatic connection management and reconnection.
+
+Key WebSocket features:
+
+- Event driven messaging
+- Smart WebSocket persistence with automatic reconnection
+- Heartbeat mechanisms to detect disconnections
+- Automatic resubscription after reconnection
+- Support for all Gate.com trading products (Spot, Margin, Futures, Options)
+- WebSocket API support for real-time trading operations
+
+### WebSocket Data Streams
+
 All available WebSockets can be used via a shared `WebsocketClient`. The WebSocket client will automatically open/track/manage connections as needed. Each unique connection (one per server URL) is tracked using a WsKey (each WsKey is a string - see [WS_KEY_MAP](src/lib/websocket/websocket-util.ts) for a list of supported values).
 
 Any subscribe/unsubscribe events will need to include a WsKey, so the WebSocket client understands which connection the event should be routed to. See examples below or in the [examples](./examples/) folder on GitHub.
@@ -7428,6 +7500,12 @@ DefaultLogger.silly = () => {};
 const ws = new WebsocketClient({ key: 'xxx', secret: 'yyy' }, DefaultLogger);
 ```
 
+## Use with LLMs & AI
+
+This SDK includes a bundled `llms.txt` file in the root of the repository. If you're developing with LLMs, use the included `llms.txt` with your LLM - it will significantly improve the LLMs understanding of how to correctly use this SDK.
+
+This file contains AI optimised structure of all the functions in this package, and their parameters for easier use with any learning models or artificial intelligence.
+
 ---
 
 <!-- template_contributions -->
@@ -7825,6 +7903,7 @@ import {
   GetFuturesTradingHistoryByTimeRangeReq,
   GetFuturesTradingHistoryReq,
   GetLiquidationHistoryReq,
+  GetRiskLimitTableReq,
   GetRiskLimitTiersReq,
   SubmitFuturesOrderReq,
   SubmitFuturesTriggeredOrderReq,
@@ -7980,6 +8059,7 @@ import {
   IndexConstituents,
   LiquidationHistoryRecord,
   PremiumIndexKLine,
+  RiskLimitTableTier,
   RiskLimitTier,
 } from './types/response/futures.js';
 import {
@@ -9134,6 +9214,20 @@ cancelSpotTriggeredOrder(params: {
     order_id: string;
 }): Promise<SpotPriceTriggeredOrder>
 ⋮----
+/**
+   * Set collateral currency
+   *
+   * @param params Parameters for setting collateral currency
+   * @returns Promise<{
+   *   is_success: boolean;
+   * }>
+   */
+setCollateralCurrency(params: {
+    collateral_type: 0 | 1;
+    enable_list?: string[];
+    disable_list?: string[];
+}): Promise<
+⋮----
 /**==========================================================================================================================
    * MARGIN
    * ==========================================================================================================================
@@ -10102,6 +10196,16 @@ batchUpdateFuturesOrders(params: {
     orders: BatchAmendOrderReq[];
 }): Promise<BatchAmendOrderResp[]>
 ⋮----
+/**
+   * Query risk limit table by table_id
+   *
+   * @param params Parameters for querying risk limit table
+   * @returns Promise<RiskLimitTableTier[]>
+   */
+getRiskLimitTable(
+    params: GetRiskLimitTableReq,
+): Promise<RiskLimitTableTier[]>
+⋮----
 /**
    * Create a price-triggered order
    *
@@ -11412,7 +11516,7 @@ File: package.json
 ================
 {
   "name": "gateio-api",
-  "version": "1.2.3",
+  "version": "1.2.6",
   "description": "Complete & Robust Node.js SDK for Gate.com's REST APIs, WebSockets & WebSocket APIs, with TypeScript declarations.",
   "scripts": {
     "clean": "rm -rf dist/*",
@@ -11432,7 +11536,8 @@ File: package.json
   },
   "type": "module",
   "files": [
-    "dist/*"
+    "dist/*",
+    "llms.txt"
   ],
   "author": "Tiago Siebler (https://github.com/tiagosiebler)",
   "contributors": [