@hot-pot/hotpot-sdk-ts 0.0.2 → 0.0.4

package/dist/apiClient.d.ts

@@ -53,7 +53,7 @@ export declare class HotPotApiClient {
      * @param active Whether to show only active swaps (default: false)
      * @returns A promise that resolves to a paginated response of PublicSwapWithAdditionalInfo objects
      */
-    listRetailUserHistory(walletAddressOrRetailId: string, limit?: number, offset?: number, active?: boolean): Promise<PaginatedResponse<PublicSwapWithAdditionalInfo>>;
+    listRetailUserHistory(walletAddresses: string[], retailId: string | null, limit?: number, offset?: number, active?: boolean): Promise<PaginatedResponse<PublicSwapWithAdditionalInfo>>;
     /**
      * Retrieves swap details by intent ID
      * @param intentId The intent ID to retrieve swap details for

package/dist/apiClient.js

@@ -1,4 +1,5 @@
 import axios from 'axios';
+import { MissingRequiredQueryParamsError } from 'errors';
 export class HotPotApiClient {
     client;
     constructor(apiUrl, apiKey, axiosInstance, config) {
@@ -26,7 +27,7 @@ export class HotPotApiClient {
      * @returns A promise that resolves to the Quote object
      */
     async getQuote(sourceChain, sourceToken, destChain, destToken, amount, slippageBps, swapType, retailUserId = null, depositType) {
-        const response = await this.client.post('/quotes/best', {
+        const response = await this.client.post('/v1/quotes/best', {
             source_chain: sourceChain,
             source_token: sourceToken,
             dest_chain: destChain,
@@ -49,7 +50,7 @@ export class HotPotApiClient {
      * @returns A promise that resolves to the CreateIntentData object
      */
     async createIntent(quoteId, userSourcePublicKey, userSourceAddress, userDestinationAddress, refundAddress) {
-        const response = await this.client.post('/intents', {
+        const response = await this.client.post('/v1/intents', {
             quote_id: quoteId,
             user_source_public_key: userSourcePublicKey,
             user_source_address: userSourceAddress,
@@ -64,7 +65,7 @@ export class HotPotApiClient {
      * @param intentId The intent ID to add the approval to
      */
     async addApproval(signedData, intentId) {
-        await this.client.post(`/intents/${intentId}/approvals`, signedData);
+        await this.client.post(`/v1/intents/${intentId}/approvals`, signedData);
     }
     /**
      * Retrieves details of a specific intent
@@ -72,7 +73,7 @@ export class HotPotApiClient {
      * @returns A promise that resolves to the PublicSwapWithAdditionalInfo object
      */
     async getIntent(intentId) {
-        const response = await this.client.get(`/intents/${intentId}`);
+        const response = await this.client.get(`/v1/intents/${intentId}`);
         return response.data;
     }
     /**
@@ -81,7 +82,7 @@ export class HotPotApiClient {
      * @returns A promise that resolves to the IntentStatus
      */
     async getIntentStatus(intentId) {
-        const response = await this.client.get(`/intents/${intentId}/status`);
+        const response = await this.client.get(`/v1/intents/${intentId}/status`);
         return response.data.status;
     }
     /**
@@ -92,8 +93,28 @@ export class HotPotApiClient {
      * @param active Whether to show only active swaps (default: false)
      * @returns A promise that resolves to a paginated response of PublicSwapWithAdditionalInfo objects
      */
-    async listRetailUserHistory(walletAddressOrRetailId, limit = 20, offset = 0, active = false) {
-        const response = await this.client.get(`/swaps/history/${walletAddressOrRetailId}?limit=${limit}&offset=${offset}&active=${active}`);
+    async listRetailUserHistory(walletAddresses, retailId, limit = 20, offset = 0, active = false) {
+        if (walletAddresses.length <= 0 && !retailId) {
+            throw new MissingRequiredQueryParamsError();
+        }
+        let url = '/v1/swaps/history';
+        let walletAddressesQuery;
+        if (walletAddresses.length > 0) {
+            walletAddressesQuery = '?wallet=' + walletAddresses.join('&wallet=');
+        }
+        else {
+            walletAddressesQuery = '';
+        }
+        url += walletAddressesQuery;
+        if (retailId) {
+            if (walletAddressesQuery !== '') {
+                url += `&retail_id=${retailId}`;
+            }
+            else {
+                url += `?retail_id=${retailId}`;
+            }
+        }
+        const response = await this.client.get(`${url}&limit=${limit}&offset=${offset}&active=${active}`);
         return response.data;
     }
     /**
@@ -102,7 +123,7 @@ export class HotPotApiClient {
      * @returns A promise that resolves to the PublicSwapWithAdditionalInfo object
      */
     async getSwapByIntentId(intentId) {
-        const response = await this.client.get(`/swaps/intents/${intentId}`);
+        const response = await this.client.get(`/v1/swaps/intents/${intentId}`);
         return response.data;
     }
     /**
@@ -111,7 +132,7 @@ export class HotPotApiClient {
      * @returns A promise that resolves to an array of Network objects
      */
     async listNetworks(token) {
-        const endpoint = token ? `/networks?token=${token}` : '/networks';
+        const endpoint = token ? `/v1/networks?token=${token}` : '/v1/networks';
         const response = await this.client.get(endpoint);
         return response.data;
     }
@@ -124,7 +145,7 @@ export class HotPotApiClient {
      * @returns A promise that resolves to a paginated response of Token objects
      */
     async listTokens(limit = 20, offset = 0, q, networkId) {
-        let endpoint = `/tokens?limit=${limit}&offset=${offset}`;
+        let endpoint = `/v1/tokens?limit=${limit}&offset=${offset}`;
         if (q) {
             endpoint += `&q=${q}`;
         }

package/dist/errors.d.ts

@@ -12,3 +12,6 @@ export declare class InsufficientAllowanceError extends Error {
     entity: string;
     constructor(apiError: ApiError);
 }
+export declare class MissingRequiredQueryParamsError extends Error {
+    constructor();
+}

package/dist/errors.js

@@ -11,3 +11,9 @@ export class InsufficientAllowanceError extends Error {
         this.entity = apiError.entity;
     }
 }
+export class MissingRequiredQueryParamsError extends Error {
+    constructor() {
+        super('Missing required query parameters');
+        this.name = 'MissingRequiredQueryParamsError';
+    }
+}

package/examples/intent/main.ts

@@ -1,6 +1,6 @@
 import { HotPotApiClient } from '../../src/apiClient.js';
 import { preparePermit2Approval } from '../../src/approvals.js';
-import { SwapType } from '../../src/types.js';
+import { type DepositType, SwapType } from '../../src/types.js';
 
 async function main() {
     // Initialize the HotPot API client with the API key from environment variables
@@ -19,6 +19,7 @@ async function main() {
     const amount = 1_000_000; // Amount in USD (or base units depending on token)
     const slippageBps = 50n; // 0.5% slippage
     const swapType = SwapType.Optimized;
+    const depositType: DepositType = 'escrowed';
 
     // Get a quote for the swap
     console.log('Getting quote...');
@@ -30,6 +31,8 @@ async function main() {
         amount,
         slippageBps,
         swapType,
+        null,
+        depositType,
     );
     console.log('Quote received:', quote);
 

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@hot-pot/hotpot-sdk-ts",
     "private": false,
-    "version": "0.0.2",
+    "version": "0.0.4",
     "type": "module",
     "main": "./dist/index.js",
     "module": "./dist",

package/src/apiClient.ts

@@ -1,5 +1,6 @@
 import type { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 import axios from 'axios';
+import { MissingRequiredQueryParamsError } from 'errors';
 
 import type {
     CreateIntentData,
@@ -58,7 +59,7 @@ export class HotPotApiClient {
         retailUserId: string | null = null,
         depositType: DepositType,
     ): Promise<Quote> {
-        const response: AxiosResponse<Quote> = await this.client.post('/quotes/best', {
+        const response: AxiosResponse<Quote> = await this.client.post('/v1/quotes/best', {
             source_chain: sourceChain,
             source_token: sourceToken,
             dest_chain: destChain,
@@ -89,7 +90,7 @@ export class HotPotApiClient {
         userDestinationAddress: string,
         refundAddress: string,
     ): Promise<CreateIntentData> {
-        const response: AxiosResponse<CreateIntentData> = await this.client.post('/intents', {
+        const response: AxiosResponse<CreateIntentData> = await this.client.post('/v1/intents', {
             quote_id: quoteId,
             user_source_public_key: userSourcePublicKey,
             user_source_address: userSourceAddress,
@@ -106,7 +107,7 @@ export class HotPotApiClient {
      * @param intentId The intent ID to add the approval to
      */
     async addApproval(signedData: SignedApproval, intentId: string): Promise<void> {
-        await this.client.post(`/intents/${intentId}/approvals`, signedData);
+        await this.client.post(`/v1/intents/${intentId}/approvals`, signedData);
     }
 
     /**
@@ -116,7 +117,7 @@ export class HotPotApiClient {
      */
     async getIntent(intentId: string): Promise<PublicSwapWithAdditionalInfo> {
         const response: AxiosResponse<PublicSwapWithAdditionalInfo> = await this.client.get(
-            `/intents/${intentId}`,
+            `/v1/intents/${intentId}`,
         );
 
         return response.data;
@@ -129,7 +130,7 @@ export class HotPotApiClient {
      */
     async getIntentStatus(intentId: string): Promise<IntentStatus> {
         const response: AxiosResponse<{ status: IntentStatus }> = await this.client.get(
-            `/intents/${intentId}/status`,
+            `/v1/intents/${intentId}/status`,
         );
 
         return response.data.status;
@@ -144,15 +145,37 @@ export class HotPotApiClient {
      * @returns A promise that resolves to a paginated response of PublicSwapWithAdditionalInfo objects
      */
     async listRetailUserHistory(
-        walletAddressOrRetailId: string,
+        walletAddresses: string[],
+        retailId: string | null,
         limit: number = 20,
         offset: number = 0,
         active: boolean = false,
     ): Promise<PaginatedResponse<PublicSwapWithAdditionalInfo>> {
+        if (walletAddresses.length <= 0 && !retailId) {
+            throw new MissingRequiredQueryParamsError();
+        }
+
+        let url = '/v1/swaps/history';
+
+        let walletAddressesQuery;
+        if (walletAddresses.length > 0) {
+            walletAddressesQuery = '?wallet=' + walletAddresses.join('&wallet=');
+        } else {
+            walletAddressesQuery = '';
+        }
+
+        url += walletAddressesQuery;
+
+        if (retailId) {
+            if (walletAddressesQuery !== '') {
+                url += `&retail_id=${retailId}`;
+            } else {
+                url += `?retail_id=${retailId}`;
+            }
+        }
+
         const response: AxiosResponse<PaginatedResponse<PublicSwapWithAdditionalInfo>> =
-            await this.client.get(
-                `/swaps/history/${walletAddressOrRetailId}?limit=${limit}&offset=${offset}&active=${active}`,
-            );
+            await this.client.get(`${url}&limit=${limit}&offset=${offset}&active=${active}`);
 
         return response.data;
     }
@@ -164,7 +187,7 @@ export class HotPotApiClient {
      */
     async getSwapByIntentId(intentId: string): Promise<PublicSwapWithAdditionalInfo> {
         const response: AxiosResponse<PublicSwapWithAdditionalInfo> = await this.client.get(
-            `/swaps/intents/${intentId}`,
+            `/v1/swaps/intents/${intentId}`,
         );
 
         return response.data;
@@ -176,7 +199,7 @@ export class HotPotApiClient {
      * @returns A promise that resolves to an array of Network objects
      */
     async listNetworks(token?: string): Promise<Network[]> {
-        const endpoint = token ? `/networks?token=${token}` : '/networks';
+        const endpoint = token ? `/v1/networks?token=${token}` : '/v1/networks';
         const response: AxiosResponse<Network[]> = await this.client.get(endpoint);
 
         return response.data;
@@ -196,7 +219,7 @@ export class HotPotApiClient {
         q?: string,
         networkId?: number,
     ): Promise<PaginatedResponse<Token>> {
-        let endpoint = `/tokens?limit=${limit}&offset=${offset}`;
+        let endpoint = `/v1/tokens?limit=${limit}&offset=${offset}`;
         if (q) {
             endpoint += `&q=${q}`;
         }

package/src/errors.ts

@@ -21,3 +21,10 @@ export class InsufficientAllowanceError extends Error {
         this.entity = apiError.entity;
     }
 }
+
+export class MissingRequiredQueryParamsError extends Error {
+    constructor() {
+        super('Missing required query parameters');
+        this.name = 'MissingRequiredQueryParamsError';
+    }
+}