Merge pull request #29 from JJ-Cro/RelNotes9_9_24

v1.0.16 feat(): Added new endpoints, updated types, updated endpoint map

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gateio-api",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "description": "Complete & robust Node.js SDK for Gate.io's REST APIs, WebSockets & WebSocket APIs, with TypeScript declarations.",
   "scripts": {
     "clean": "rm -rf dist/*",

src/RestClient.ts

@@ -98,6 +98,7 @@ import {
   GetOptionsSettlementHistoryReq,
   GetOptionsTradesReq,
   GetOptionsUnderlyingCandlesReq,
+  OptionsMMPSettingsReq,
   SubmitOptionsOrderReq,
 } from './types/request/options.js';
 import {
@@ -244,6 +245,7 @@ import {
   OptionsAccountChangeRecord,
   OptionsCandle,
   OptionsContract,
+  OptionsMMPSettings,
   OptionsOrderBook,
   OptionsPositionsUnderlying,
   OptionsSettlementHistoryRecord,
@@ -910,13 +912,7 @@ export class RestClient extends BaseRestClient {
   /**
    * Query mode of the unified account
    *
-   * @returns Promise<{
-   *   mode: 'classic' | 'multi_currency' | 'portfolio';
-   *   settings: {
-   *     usdt_futures?: boolean;
-   *     spot_hedge?: boolean;
-   *   };
-   * }>
+   * @returns Promise<SetUnifiedAccountModeReq>
    */
   getUnifiedAccountMode(): Promise<SetUnifiedAccountModeReq> {
     return this.getPrivate('/unified/unified_mode');
@@ -3283,6 +3279,42 @@ export class RestClient extends BaseRestClient {
     return this.getPrivate(`/options/my_trades`, params);
   }
 
+  /**
+   * Set MMP (Market Maker Protection) settings
+   *
+   * @param params Parameters for setting MMP settings
+   * @returns Promise<OptionsMMPSetings>
+   */
+  setOptionsMMPSettings(
+    params: OptionsMMPSettingsReq,
+  ): Promise<OptionsMMPSettings> {
+    return this.postPrivate('/options/mmp', { body: params });
+  }
+
+  /**
+   * Query MMP (Market Maker Protection) settings
+   *
+   * @param params Parameters for querying MMP settings
+   * @returns Promise<OptionsMMPSetings[]>
+   */
+  getOptionsMMPSettings(params?: {
+    underlying?: string;
+  }): Promise<OptionsMMPSettings[]> {
+    return this.getPrivate('/options/mmp', params);
+  }
+
+  /**
+   * Reset MMP (Market Maker Protection) settings
+   *
+   * @param params Parameters for resetting MMP settings
+   * @returns Promise<OptionsMMPSettings>
+   */
+  resetOptionsMMPSettings(params: {
+    underlying: string;
+  }): Promise<OptionsMMPSettings> {
+    return this.postPrivate('/options/mmp/reset', { body: params });
+  }
+
   /**==========================================================================================================================
    * EARN UNI
    * ==========================================================================================================================

src/types/request/options.ts

@@ -87,3 +87,11 @@ export interface GetOptionsPersonalHistoryReq {
   from?: number;
   to?: number;
 }
+
+export interface OptionsMMPSettingsReq {
+  underlying: string;
+  window: number; // Time window in milliseconds, between 1-5000, 0 to disable MMP
+  frozen_period: number; // Frozen period in milliseconds, 0 to freeze indefinitely until reset API is called
+  qty_limit: string; // Maximum transaction volume (positive number, up to 2 decimal places)
+  delta_limit: string; // Maximum net delta value (positive number, up to 2 decimal places)
+}

src/types/request/unified.ts

@@ -23,6 +23,8 @@ export interface GetUnifiedInterestRecordsReq {
   currency?: string;
   page?: number;
   limit?: number;
+  from?: number;
+  to?: number;
   type?: 'platform' | 'margin';
 }
 
@@ -31,6 +33,8 @@ export interface SetUnifiedAccountModeReq {
   settings?: {
     usdt_futures?: boolean;
     spot_hedge?: boolean;
+    use_funding?: boolean;
+    options?: boolean;
   };
 }
 

src/types/response/options.ts

@@ -204,3 +204,13 @@ export interface OptionsUserHistoryRecord {
   underlying_price: string;
   role: 'taker' | 'maker';
 }
+
+export interface OptionsMMPSettings {
+  underlying: string;
+  window: number;
+  frozen_period: number;
+  qty_limit: string;
+  delta_limit: string;
+  trigger_time_ms: number; // Trigger freeze time in milliseconds, 0 means no freeze triggered
+  frozen_until_ms: number; // Unfreeze time in milliseconds, if no frozen period is configured, no unfreeze time after freeze is triggered
+}

src/types/response/withdrawal.ts

@@ -1,6 +1,7 @@
 export interface WithdrawalRecord {
   id: string;
   txid: string;
+  block_number: string;
   withdraw_order_id: string;
   timestamp: string;
   amount: string;