Update typescript SDK (#41)

Author: AnsonSIDAN

package-lock.json

@@ -1,7 +1,7 @@
 {
     "name": "@deltadefi-protocol/typescript-sdk",
     "description": "The Typescript SDK for interacting with DeltaDeFi protocol",
-    "version": "0.3.22",
+    "version": "0.3.23",
     "main": "./dist/index.cjs",
     "browser": "./dist/index.js",
     "module": "./dist/index.js",

package.json

@@ -11,6 +11,7 @@ import {
     BuildWithdrawalTransactionResponse,
     SubmitWithdrawalTransactionRequest,
     SubmitWithdrawalTransactionResponse,
+    GetOrderRecordRequest,
     GetOrderRecordResponse,
     GetDepositRecordsResponse,
     GetWithdrawalRecordsResponse,
@@ -95,8 +96,8 @@ export class Accounts extends Api {
      * Retrieves order records.
      * @returns A promise that resolves to the order records response.
      */
-    public getOrderRecords(): Promise<GetOrderRecordResponse> {
-        const res = this.axiosInstance.get('/accounts/order-records');
+    public getOrderRecords(data: GetOrderRecordRequest): Promise<GetOrderRecordResponse> {
+        const res = this.axiosInstance.get('/accounts/order-records', { params: data });
         return this.resolveAxiosData(res);
     }
 

src/client/accounts/index.ts

@@ -46,7 +46,7 @@ export class ApiClient {
             if (network === 'mainnet') {
                 // TODO: input production link once available
                 baseURL = 'https://api.deltadefi.io';
-                wsURL = 'wss://api-staging.deltadefi.io';
+                wsURL = 'wss://api.deltadefi.io';
             } else {
                 baseURL = 'https://api-staging.deltadefi.io';
                 wsURL = 'wss://api-staging.deltadefi.io';

src/client/index.ts

@@ -1,6 +1,12 @@
-export type TradingSymbol = 'ADAUSDX';
+export type TradingSymbol = 'ADAUSDM';
 
-export type OrderStatus = 'building' | 'processing' | 'open' | 'closed' | 'failed' | 'cancelled';
+export type OrderStatus =
+    | 'open'
+    | 'fully_filled'
+    | 'partially_filled'
+    | 'cancelled'
+    | 'partially_cancelled'
+    | 'failed';
 
 export type OrderSide = 'buy' | 'sell';
 
@@ -47,3 +53,17 @@ export type OrderJSON = {
     update_time: number;
     fills?: OrderExecutionRecordJSON[];
 };
+
+export type OrderFillingRecordJSON = {
+    execution_id: string;
+    order_id: string;
+    status: OrderStatus;
+    symbol: TradingSymbol;
+    executed_qty: string;
+    side: OrderSide;
+    type: OrderType;
+    fee_charged: string;
+    fee_unit: string;
+    executed_price: number;
+    created_time: number;
+};

src/types/models/order.ts

@@ -79,8 +79,10 @@ export type SubmitCancelOrderTransactionRequest = {
     signed_tx: string;
 };
 
-export type Status = 'open' | 'closed';
+export type Status = 'openOrder' | 'orderHistory' | 'tradingHistory';
 
 export type GetOrderRecordRequest = {
-    status?: Status;
+    status: Status; // Must be either 'openOrder' | 'orderHistory' | 'tradingHistory'
+    limit: number; // default number is 10 while number must be between 1 and 250
+    page: number; // default number is 1 while number must be between 1 and 1000
 };

src/types/requests/index.ts

@@ -1,5 +1,4 @@
-import { Asset } from '@meshsdk/core';
-import { OrderJSON, AccountBalance } from '../models';
+import { OrderJSON, AccountBalance, OrderFillingRecordJSON } from '../models';
 
 export type SignInResponse = {
     token: string;
@@ -40,23 +39,30 @@ export type GetOperationKeyResponse = {
 
 export type TransactionStatus = 'building' | 'submitted' | 'submission_failed' | 'confirmed';
 
+export type AssetRecord = {
+    asset: string;
+    asset_unit: string;
+    qty: number;
+};
+
 export type DepositRecord = {
     created_at: string;
     status: TransactionStatus;
-    assets: Asset[];
+    assets: AssetRecord[];
     tx_hash: string;
 };
 
 export type GetDepositRecordsResponse = DepositRecord[];
 
 export type GetOrderRecordResponse = {
-    Orders: OrderJSON[];
+    orders: OrderJSON[];
+    order_filling_records: OrderFillingRecordJSON[];
 };
 
 export type WithdrawalRecord = {
     created_at: string;
     status: TransactionStatus;
-    assets: Asset[];
+    assets: AssetRecord[];
 };
 
 export type GetWithdrawalRecordsResponse = WithdrawalRecord[];
@@ -127,9 +133,7 @@ export type BuildCancelOrderTransactionResponse = {
     tx_hex: string;
 };
 
-export type SubmitCancelOrderTransactionResponse = {
-    tx_hash: string;
-};
+export type SubmitCancelOrderTransactionResponse = object;
 
 export type GetAPIKeyResponse = {
     api_key: string;