Merge pull request #45 from deltadefi-protocol/feat-internal-transfer

Feat internal transfer

Author: kenlau666

package.json

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

src/client/accounts/index.ts

@@ -24,6 +24,14 @@ import {
     BuildTransferalTransactionResponse,
     SubmitTransferalTransactionRequest,
     SubmitTransferalTransactionResponse,
+    BuildTransferalRequestTransactionRequest,
+    BuildTransferalRequestTransactionResponse,
+    SubmitTransferalRequestTransactionRequest,
+    SubmitTransferalRequestTransactionResponse,
+    GetTransferalRecordsResponse,
+    GetTransferalRecordsRequest,
+    GetTransferalRecordByTxHashRequest,
+    GetTransferalRecordByTxHashResponse,
 } from '../../types';
 import { Api } from '../api';
 
@@ -116,6 +124,30 @@ export class Accounts extends Api {
         return this.resolveAxiosData(res);
     }
 
+    /**
+     * Retrieves transferal records.
+     * @param data - The transferal records request parameters.
+     * @returns A promise that resolves to the transferal records response.
+     */
+    public getTransferalRecords(
+        data: GetTransferalRecordsRequest,
+    ): Promise<GetTransferalRecordsResponse> {
+        const res = this.axiosInstance.get(`/accounts/transferal-records`, { params: data });
+        return this.resolveAxiosData(res);
+    }
+
+    /**
+     * Retrieves a single transferal record by transaction hash.
+     * @param txHash - The transaction hash of the transferal record to retrieve.
+     * @returns A promise that resolves to the transferal record response.
+     */
+    public getTransferalRecordByTxHash(
+        data: GetTransferalRecordByTxHashRequest,
+    ): Promise<GetTransferalRecordByTxHashResponse> {
+        const res = this.axiosInstance.get(`/accounts/transferal-records/${data.tx_hash}`);
+        return this.resolveAxiosData(res);
+    }
+
     /**
      * Retrieves account balance.
      * @returns A promise that resolves to the account balance response.
@@ -184,6 +216,18 @@ export class Accounts extends Api {
         return this.resolveAxiosData(res);
     }
 
+    /**
+     * Builds a transferal request transaction.
+     * @param data - The build transferal transaction request data.
+     * @returns A promise that resolves to the build transferal transaction response.
+     */
+    public buildTransferalRequestTransaction(
+        data: BuildTransferalRequestTransactionRequest,
+    ): Promise<BuildTransferalRequestTransactionResponse> {
+        const res = this.axiosInstance.post('/accounts/request-transferal/build', data);
+        return this.resolveAxiosData(res);
+    }
+
     /**
      * Submits a deposit transaction.
      * @param data - The submit deposit transaction request data.
@@ -213,10 +257,22 @@ export class Accounts extends Api {
      * @param data - The submit transferal transaction request data.
      * @returns A promise that resolves to the submit transferal transaction response.
      */
-    public submittransferalTransaction(
+    public submitTransferalTransaction(
         data: SubmitTransferalTransactionRequest,
     ): Promise<SubmitTransferalTransactionResponse> {
         const res = this.axiosInstance.post('/accounts/transferal/submit', data);
         return this.resolveAxiosData(res);
     }
+
+    /**
+     * Submits a transferal requesttransaction.
+     * @param data - The submit transferal transaction request data.
+     * @returns A promise that resolves to the submit transferal transaction response.
+     */
+    public submitTransferalRequestTransaction(
+        data: SubmitTransferalRequestTransactionRequest,
+    ): Promise<SubmitTransferalRequestTransactionResponse> {
+        const res = this.axiosInstance.post('/accounts/request-transferal/submit', data);
+        return this.resolveAxiosData(res);
+    }
 }

src/types/models/account.ts

@@ -1,3 +1,5 @@
+import { Asset } from '../requests';
+
 export type AccountBalance = {
     asset: string;
     asset_unit: string;
@@ -15,3 +17,17 @@ export type AccountBalanceStream = {
     sub_type: 'balance';
     balance: AccountBalance[];
 };
+
+export type TransferStatus = 'pending' | 'confirmed';
+
+export type TransferalType = 'normal' | 'deposit' | `withdrawal`;
+
+export type TransferDirection = 'incoming' | 'outgoing';
+
+export type TransferalRecord = {
+    created_at: string;
+    status: TransferStatus;
+    assets: Asset[];
+    tx_hash: string;
+    direction: TransferDirection;
+};

src/types/requests/index.ts

@@ -1,5 +1,6 @@
 import { UTxO } from '@meshsdk/core';
 import { TradingSymbol, OrderSide, OrderType } from '../models/order';
+import { TransferStatus } from '../models/account';
 
 // SignInRequest to be refactored
 export type SignInRequest = {
@@ -46,6 +47,15 @@ export type SubmitTransferalTransactionRequest = {
     signed_tx: string;
 };
 
+export type BuildTransferalRequestTransactionRequest = {
+    transferal_amount: Asset[];
+    from_address: string;
+};
+
+export type SubmitTransferalRequestTransactionRequest = {
+    signed_tx: string;
+};
+
 // export type GetMarketDepthRequest = {
 //     symbol: TradingSymbol;
 // };
@@ -91,3 +101,13 @@ export type GetOrderRecordRequest = {
     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
 };
+
+export type GetTransferalRecordsRequest = {
+    status: TransferStatus; // Must be either 'pending' | 'confirmed'
+    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
+};
+
+export type GetTransferalRecordByTxHashRequest = {
+    tx_hash: string;
+};

src/types/responses/index.ts

@@ -1,4 +1,4 @@
-import { OrderJSON, AccountBalance, OrderFillingRecordJSON } from '../models';
+import { OrderJSON, AccountBalance, OrderFillingRecordJSON, TransferalRecord } from '../models';
 
 export type SignInResponse = {
     token: string;
@@ -86,6 +86,10 @@ export type BuildTransferalTransactionResponse = {
     tx_hex: string;
 };
 
+export type BuildTransferalRequestTransactionResponse = {
+    tx_hex: string;
+};
+
 export type SubmitDepositTransactionResponse = {
     tx_hash: string;
 };
@@ -98,6 +102,10 @@ export type SubmitTransferalTransactionResponse = {
     tx_hash: string;
 };
 
+export type SubmitTransferalRequestTransactionResponse = {
+    tx_hash: string;
+};
+
 export type MarketDepth = {
     price: number;
     quantity: number;
@@ -143,3 +151,12 @@ export type GetAPIKeyResponse = {
     api_key: string;
     created_at: string;
 };
+
+export type GetTransferalRecordsResponse = {
+    in: TransferalRecord[];
+    out: TransferalRecord[];
+};
+
+export type GetTransferalRecordByTxHashResponse = {
+    transferal_record: TransferalRecord;
+};

tests/markets.test.ts

@@ -2,40 +2,40 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import dotenv from 'dotenv';
 import { ApiClient } from '../src';
-import { MarketDepth } from '../src/types';
+// import { MarketDepth } from '../src/types';
 
 dotenv.config();
 
 const skipApiTests = process.env.SKIP_API_TESTS === 'true';
 const apiKey = process.env.API_KEY || '';
 
-describe('GetDepthResponse', () => {
-    test('should have correct structure and non-negative values', async () => {
-        if (skipApiTests) return;
-        const api = new ApiClient({ apiKey, network: 'preprod' });
-        const res = await api.markets.getDepth({ symbol: 'ADAUSDM' });
+// describe('GetDepthResponse', () => {
+//     test('should have correct structure and non-negative values', async () => {
+//         if (skipApiTests) return;
+//         const api = new ApiClient({ apiKey, network: 'preprod' });
+//         const res = await api.markets.getDepth({ symbol: 'ADAUSDM' });
 
-        console.log('response', res);
+//         console.log('response', res);
 
-        // Check that bids and asks are arrays
-        expect(Array.isArray(res.bids)).toBe(true);
-        expect(Array.isArray(res.asks)).toBe(true);
+//         // Check that bids and asks are arrays
+//         expect(Array.isArray(res.bids)).toBe(true);
+//         expect(Array.isArray(res.asks)).toBe(true);
 
-        // Check that each bid and ask is a MarketDepth object
-        res.bids.forEach((bid: MarketDepth) => {
-            expect(typeof bid.price).toBe('number');
-            expect(bid.price).toBeGreaterThanOrEqual(0);
-            expect(typeof bid.quantity).toBe('number');
-            expect(bid.quantity).toBeGreaterThanOrEqual(0);
-        });
-        res.asks.forEach((ask: MarketDepth) => {
-            expect(typeof ask.price).toBe('number');
-            expect(ask.price).toBeGreaterThanOrEqual(0);
-            expect(typeof ask.quantity).toBe('number');
-            expect(ask.quantity).toBeGreaterThanOrEqual(0);
-        });
-    });
-});
+//         // Check that each bid and ask is a MarketDepth object
+//         res.bids.forEach((bid: MarketDepth) => {
+//             expect(typeof bid.price).toBe('number');
+//             expect(bid.price).toBeGreaterThanOrEqual(0);
+//             expect(typeof bid.quantity).toBe('number');
+//             expect(bid.quantity).toBeGreaterThanOrEqual(0);
+//         });
+//         res.asks.forEach((ask: MarketDepth) => {
+//             expect(typeof ask.price).toBe('number');
+//             expect(ask.price).toBeGreaterThanOrEqual(0);
+//             expect(typeof ask.quantity).toBe('number');
+//             expect(ask.quantity).toBeGreaterThanOrEqual(0);
+//         });
+//     });
+// });
 
 describe('GetMarketPriceRequest', () => {
     test('Buying price should have correct data format and non-negative vaule', async () => {