@hot-pot/hotpot-sdk-ts 0.0.1 → 0.0.3

package/dist/apiClient.d.ts

@@ -1,5 +1,5 @@
 import type { AxiosInstance, AxiosRequestConfig } from 'axios';
-import type { CreateIntentData, IntentStatus, Network, PaginatedResponse, PublicSwapWithAdditionalInfo, Quote, SignedApproval, SwapType, Token } from './types';
+import type { CreateIntentData, DepositType, IntentStatus, Network, PaginatedResponse, PublicSwapWithAdditionalInfo, Quote, SignedApproval, SwapType, Token } from './types';
 export declare class HotPotApiClient {
     private client;
     constructor(apiUrl: string, apiKey: string, axiosInstance?: AxiosInstance, config?: AxiosRequestConfig);
@@ -13,9 +13,10 @@ export declare class HotPotApiClient {
      * @param slippageBps The slippage in basis points
      * @param swapType The type of swap
      * @param retailUserId Optional retail user ID
+     * @param depositType The type of deposit to perform (escrowed/direct)
      * @returns A promise that resolves to the Quote object
      */
-    getQuote(sourceChain: number, sourceToken: string, destChain: number, destToken: string, amount: number, slippageBps: bigint, swapType: SwapType, retailUserId?: string | null): Promise<Quote>;
+    getQuote(sourceChain: number, sourceToken: string, destChain: number, destToken: string, amount: number, slippageBps: bigint, swapType: SwapType, retailUserId: string | null | undefined, depositType: DepositType): Promise<Quote>;
     /**
      * Creates a new swap intent with the provided details
      * @param quoteId The quote ID to use for the intent
@@ -52,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

@@ -22,9 +22,10 @@ export class HotPotApiClient {
      * @param slippageBps The slippage in basis points
      * @param swapType The type of swap
      * @param retailUserId Optional retail user ID
+     * @param depositType The type of deposit to perform (escrowed/direct)
      * @returns A promise that resolves to the Quote object
      */
-    async getQuote(sourceChain, sourceToken, destChain, destToken, amount, slippageBps, swapType, retailUserId = null) {
+    async getQuote(sourceChain, sourceToken, destChain, destToken, amount, slippageBps, swapType, retailUserId = null, depositType) {
         const response = await this.client.post('/quotes/best', {
             source_chain: sourceChain,
             source_token: sourceToken,
@@ -34,6 +35,7 @@ export class HotPotApiClient {
             slippage_bps: slippageBps.toString(),
             swap_type: swapType,
             retail_user_id: retailUserId,
+            deposit_type: depositType,
         });
         return response.data;
     }
@@ -90,8 +92,20 @@ 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) {
+        let walletAddressesQuery;
+        if (walletAddresses.length > 0) {
+            walletAddressesQuery = 'wallet=' + walletAddresses.join('&wallet=');
+        }
+        else {
+            walletAddressesQuery = '';
+        }
+        let url = '/swaps/history?';
+        url += walletAddressesQuery;
+        if (retailId) {
+            url += `&retail_id=${retailId}`;
+        }
+        const response = await this.client.get(`${url}&limit=${limit}&offset=${offset}&active=${active}`);
         return response.data;
     }
     /**

package/dist/types.d.ts

@@ -40,6 +40,7 @@ export interface Quote {
     slippage_bps: string;
     expiry: number;
     swap_type: SwapType;
+    deposit_type: DepositType;
 }
 export interface CreateIntentData {
     intent_id: string;
@@ -49,6 +50,7 @@ export interface CreateIntentData {
     params_to_sign: Permit2ApprovalToSign | HtlcApprovalToSign | CosignApprovalToSign;
 }
 export type ApprovalType = 'permit2' | 'psbt' | 'cosign';
+export type DepositType = 'escrowed' | 'direct';
 export interface CosignData {
     transaction: string;
     user_address: string;

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.1",
+    "version": "0.0.3",
     "type": "module",
     "main": "./dist/index.js",
     "module": "./dist",

package/src/apiClient.ts

@@ -3,6 +3,7 @@ import axios from 'axios';
 
 import type {
     CreateIntentData,
+    DepositType,
     IntentStatus,
     Network,
     PaginatedResponse,
@@ -43,6 +44,7 @@ export class HotPotApiClient {
      * @param slippageBps The slippage in basis points
      * @param swapType The type of swap
      * @param retailUserId Optional retail user ID
+     * @param depositType The type of deposit to perform (escrowed/direct)
      * @returns A promise that resolves to the Quote object
      */
     async getQuote(
@@ -54,6 +56,7 @@ export class HotPotApiClient {
         slippageBps: bigint,
         swapType: SwapType,
         retailUserId: string | null = null,
+        depositType: DepositType,
     ): Promise<Quote> {
         const response: AxiosResponse<Quote> = await this.client.post('/quotes/best', {
             source_chain: sourceChain,
@@ -64,6 +67,7 @@ export class HotPotApiClient {
             slippage_bps: slippageBps.toString(),
             swap_type: swapType,
             retail_user_id: retailUserId,
+            deposit_type: depositType,
         });
 
         return response.data;
@@ -140,15 +144,25 @@ 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>> {
+        let walletAddressesQuery;
+        if (walletAddresses.length > 0) {
+            walletAddressesQuery = 'wallet=' + walletAddresses.join('&wallet=');
+        } else {
+            walletAddressesQuery = '';
+        }
+        let url = '/swaps/history?';
+        url += walletAddressesQuery;
+        if (retailId) {
+            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;
     }

package/src/types.ts

@@ -43,6 +43,7 @@ export interface Quote {
     slippage_bps: string;
     expiry: number;
     swap_type: SwapType;
+    deposit_type: DepositType;
 }
 
 export interface CreateIntentData {
@@ -54,6 +55,7 @@ export interface CreateIntentData {
 }
 
 export type ApprovalType = 'permit2' | 'psbt' | 'cosign';
+export type DepositType = 'escrowed' | 'direct';
 
 export interface CosignData {
     transaction: string;