chore(): refactor & clean types

tiagosiebler · Jun 12, 2024 · 687fe8f · 687fe8f
1 parent a5efe89
commit 687fe8f
Show file tree

Hide file tree

Showing 10 changed files with 108 additions and 130 deletions.
diff --git a/src/RestClient.ts b/src/RestClient.ts
diff --git a/src/types/request/futures.ts b/src/types/request/futures.ts
@@ -23,7 +23,7 @@ export interface GetFuturesTradesReq {
   to?: number;
 }
 
-export interface GetFuturesCandlesticksReq {
+export interface GetFuturesCandlesReq {
   settle: 'btc' | 'usdt' | 'usd';
   contract: string;
   from?: number;

diff --git a/src/types/request/spot.ts b/src/types/request/spot.ts
@@ -20,7 +20,7 @@ export interface GetSpotTradesReq {
   page?: number;
 }
 
-export interface GetSpotCandlesticksReq {
+export interface GetSpotCandlesReq {
   currency_pair: string;
   limit?: number;
   from?: number;

diff --git a/src/types/response/futures.ts b/src/types/response/futures.ts
@@ -3,15 +3,15 @@
  * ==========================================================================================================================
  */
 
-export interface GetFuturesOrderBookResp {
+export interface FuturesOrderBook {
   id?: number;
   current: number;
   update: number;
   asks: { p: string; s: number }[];
   bids: { p: string; s: number }[];
 }
 
-export interface GetFuturesTradesResp {
+export interface FuturesTrade {
   id: number;
   create_time: number;
   create_time_ms: number;
@@ -21,7 +21,7 @@ export interface GetFuturesTradesResp {
   is_internal?: boolean;
 }
 
-export interface GetFuturesCandlesticksResp {
+export interface FuturesCandle {
   t: number;
   v?: number;
   c: string;
@@ -31,15 +31,15 @@ export interface GetFuturesCandlesticksResp {
   sum: string;
 }
 
-export interface GetPremiumIndexKLineResp {
+export interface PremiumIndexKLine {
   t: number;
   c: string;
   h: string;
   l: string;
   o: string;
 }
 
-export interface GetFuturesTickersResp {
+export interface FuturesTicker {
   contract: string;
   last: string;
   change_percentage: string;

diff --git a/src/types/response/spot.ts b/src/types/response/spot.ts
@@ -3,7 +3,7 @@
  * ==========================================================================================================================
  */
 
-export interface GetSpotCurrenciesResp {
+export interface SpotCurrency {
   currency: string;
   delisted: boolean;
   withdraw_disabled: boolean;
@@ -14,7 +14,7 @@ export interface GetSpotCurrenciesResp {
   chain: string;
 }
 
-export interface GetSpotTickerResp {
+export interface SpotTicker {
   currency_pair: string;
   last: string;
   lowest_ask: string;
@@ -32,15 +32,15 @@ export interface GetSpotTickerResp {
   etf_leverage: string | null;
 }
 
-export interface GetSpotOrderBookResp {
+export interface SpotOrderBook {
   id?: number;
   current: number;
   update: number;
   asks: [string, string][];
   bids: [string, string][];
 }
 
-export interface GetSpotTradesResp {
+export interface SpotTrade {
   id: string;
   create_time: string;
   create_time_ms: string;
@@ -59,20 +59,18 @@ export interface GetSpotTradesResp {
   text: string;
 }
 
-export type GetSpotCandlesticksResp = [
-  [
-    string, // Unix timestamp with second precision
-    string, // Trading volume in quote currency
-    string, // Closing price
-    string, // Highest price
-    string, // Lowest price
-    string, // Opening price
-    string, // Trading volume in base currency
-    boolean, // Whether the window is closed
-  ],
+export type SpotCandle = [
+  string, // Unix timestamp with second precision
+  string, // Trading volume in quote currency
+  string, // Closing price
+  string, // Highest price
+  string, // Lowest price
+  string, // Opening price
+  string, // Trading volume in base currency
+  boolean, // Whether the window is closed
 ];
 
-export interface GetSpotFeeRatesResp {
+export interface SpotFeeRates {
   user_id: number;
   taker_fee: string;
   maker_fee: string;
@@ -85,29 +83,14 @@ export interface GetSpotFeeRatesResp {
   debit_fee: number;
 }
 
-export interface GetSpotBatchFeeRatesResp {
-  [key: string]: {
-    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;
-    currency_pair: string;
-    debit_fee: number;
-  };
-}
-
-export interface GetSpotAccountsResp {
+export interface SpotAccount {
   currency: string;
   available: string;
   locked: string;
   update_id: number;
 }
 
-export interface GetSpotAccountBookResp {
+export interface SpotAccountBook {
   id: string;
   time: number;
   currency: string;

diff --git a/src/types/response/subaccount.ts b/src/types/response/subaccount.ts
@@ -1,4 +1,4 @@
-export interface SubAccountResp {
+export interface SubAccount {
   remark?: string;
   login_name: string;
   password?: string;
@@ -9,7 +9,7 @@ export interface SubAccountResp {
   create_time: number;
 }
 
-export interface CreateSubAccountApiKeyResp {
+export interface CreatedSubAccountAPIKey {
   user_id: string;
   mode?: number;
   name?: string;
@@ -34,7 +34,7 @@ export interface CreateSubAccountApiKeyResp {
   last_access: number;
 }
 
-export interface SubAccountKey {
+export interface SubAccountAPIKey {
   user_id?: string;
   mode?: number;
   name?: string;

diff --git a/src/types/response/unified.ts b/src/types/response/unified.ts
@@ -1,4 +1,4 @@
-export interface GetUnifiedAccountInfoResp {
+export interface UnifiedAccountInfo {
   user_id: number;
   refresh_time: number;
   locked: boolean;
@@ -31,7 +31,7 @@ export interface GetUnifiedAccountInfoResp {
   spot_hedge: boolean;
 }
 
-export interface GetUnifiedLoansResp {
+export interface UnifiedLoan {
   currency: string;
   currency_pair: string;
   amount: string;
@@ -40,7 +40,7 @@ export interface GetUnifiedLoansResp {
   update_time: number;
 }
 
-export interface GetUnifiedLoanRecordsResp {
+export interface UnifiedLoanRecord {
   id: number;
   type: 'borrow' | 'repay';
   repayment_type: 'none' | 'manual_repay' | 'auto_repay' | 'cancel_auto_repay';
@@ -49,7 +49,7 @@ export interface GetUnifiedLoanRecordsResp {
   amount: string;
   create_time: number;
 }
-export interface GetUnifiedInterestRecordsResp {
+export interface UnifiedInterestRecord {
   currency: string;
   currency_pair: string;
   actual_rate: string;
@@ -84,7 +84,7 @@ export interface GetUnifiedCurrencyDiscountTiersResp {
   }[];
 }
 
-export interface PortfolioMarginCalculatorResp {
+export interface PortfolioMarginCalculation {
   maintain_margin_total: string;
   initial_margin_total: string;
   calculate_time: number;

diff --git a/src/types/response/wallet.ts b/src/types/response/wallet.ts
@@ -1,4 +1,4 @@
-export interface GetCurrencyChainsResp {
+export interface CurrencyChain {
   chain: string;
   name_cn: string;
   name_en: string;
@@ -21,7 +21,7 @@ export interface CreateDepositAddressResp {
   }[];
 }
 
-export interface SubAccountTransferRecordResp {
+export interface SubAccountTransferRecord {
   currency: string;
   sub_account: string;
   direction: 'to' | 'from';
@@ -133,7 +133,7 @@ export interface SubAccountCrossMarginBalancesResp {
   };
 }
 
-export interface GetSavedAddressResp {
+export interface SavedAddress {
   currency: string;
   chain: string;
   address: string;
@@ -175,7 +175,7 @@ export interface GetBalancesResp {
   };
 }
 
-export interface GetSmallBalancesResp {
+export interface SmallBalanceRecord {
   currency: string;
   available_balance: string;
   estimated_as_btc: string;

diff --git a/src/types/response/withdrawal.ts b/src/types/response/withdrawal.ts
@@ -1,4 +1,4 @@
-export interface Withdrawal {
+export interface WithdrawalRecord {
   id: string;
   txid: string;
   withdraw_order_id: string;

diff --git a/src/types/shared.ts b/src/types/shared.ts
@@ -5,6 +5,7 @@ export type GateBaseUrlKey =
 
 // interfaces
 
+// Used for spot and flash swap
 export interface CurrencyPair {
   id?: string;
   base?: string;