fix: overload getQuote method (#617)

* fix: overload getQuote method

* chore: merge types for get quote

---------

Co-authored-by: Slava <slava@interlay.io>

Author: nakul1010

sdk/src/gateway/client.ts

@@ -127,82 +127,86 @@ export class GatewayApiClient {
         return Object.values(Chain);
     }
 
-    /**
-     *
-     * Get a quote from the Gateway API for swapping or staking BTC.
-     *
-     * @param params The parameters for the quote.
-     */
+    async getQuote(params: {
+        type: 'onramp';
+        params: Optional<
+            GatewayQuoteParams,
+            'amount' | 'fromChain' | 'fromToken' | 'fromUserAddress' | 'toUserAddress'
+        >;
+    }): Promise<GatewayQuote & GatewayTokensInfo>;
+
+    async getQuote(params: {
+        type: 'offramp';
+        params: {
+            tokenAddress: Address;
+            amount: number;
+        };
+    }): Promise<OfframpQuote>;
 
-    async getQuote({
-        type,
-        params,
-    }:
-        | {
-              type: 'onramp';
-              params: Optional<
-                  GatewayQuoteParams,
-                  'amount' | 'fromChain' | 'fromToken' | 'fromUserAddress' | 'toUserAddress'
-              >;
-          }
-        | {
-              type: 'offramp';
-              params: {
-                  tokenAddress: Address;
-                  amount: bigint;
-              };
-          }): Promise<(GatewayQuote & GatewayTokensInfo) | OfframpQuote> {
-        if (type === 'onramp') {
-            const isMainnet =
-                params.toChain === ChainId.BOB ||
-                (typeof params.toChain === 'string' && params.toChain.toLowerCase() === Chain.BOB);
-            const isTestnet =
-                params.toChain === ChainId.BOB_SEPOLIA ||
-                (typeof params.toChain === 'string' && params.toChain.toLowerCase() === Chain.BOB_SEPOLIA);
-
-            const isInvalidNetwork = !isMainnet && !isTestnet;
-            const isMismatchMainnet = isMainnet && this.chain !== Chain.BOB;
-            const isMismatchTestnet = isTestnet && this.chain !== Chain.BOB_SEPOLIA;
-
-            // TODO: switch URL if `toChain` is different chain?
-            if (isInvalidNetwork || isMismatchMainnet || isMismatchTestnet) {
-                throw new Error('Invalid output chain');
-            }
+    async getQuote(
+        params:
+            | {
+                  type: 'onramp';
+                  params: Optional<
+                      GatewayQuoteParams,
+                      'amount' | 'fromChain' | 'fromToken' | 'fromUserAddress' | 'toUserAddress'
+                  >;
+              }
+            | {
+                  type: 'offramp';
+                  params: {
+                      tokenAddress: Address;
+                      amount: number;
+                  };
+              }
+    ): Promise<(GatewayQuote & GatewayTokensInfo) | OfframpQuote> {
+        if (params.type === 'onramp') {
+            return this.getOnrampQuote(params.params);
+        } else {
+            return this.fetchOfframpQuote(params.params.tokenAddress, params.params.amount);
+        }
+    }
 
-            let strategyAddress: string | undefined;
+    private async getOnrampQuote(
+        params: Optional<GatewayQuoteParams, 'amount' | 'fromChain' | 'fromToken' | 'fromUserAddress' | 'toUserAddress'>
+    ): Promise<GatewayQuote & GatewayTokensInfo> {
+        const isMainnet =
+            params.toChain === ChainId.BOB ||
+            (typeof params.toChain === 'string' && params.toChain.toLowerCase() === Chain.BOB);
+        const isTestnet =
+            params.toChain === ChainId.BOB_SEPOLIA ||
+            (typeof params.toChain === 'string' && params.toChain.toLowerCase() === Chain.BOB_SEPOLIA);
 
-            const toToken = params.toToken.toLowerCase();
-            const outputTokenAddress = getTokenAddress(this.chainId, toToken);
-            if (params.strategyAddress?.startsWith('0x')) {
-                strategyAddress = params.strategyAddress;
-            }
+        if (
+            (!isMainnet && !isTestnet) ||
+            (isMainnet && this.chain !== Chain.BOB) ||
+            (isTestnet && this.chain !== Chain.BOB_SEPOLIA)
+        ) {
+            throw new Error('Invalid output chain');
+        }
 
-            const url = new URL(`${this.baseUrl}/quote/${outputTokenAddress}`);
-            if (strategyAddress) {
-                url.searchParams.append('strategy', `${strategyAddress}`);
-            }
-            const atomicAmount = params.amount;
-            if (atomicAmount) {
-                url.searchParams.append('satoshis', `${atomicAmount}`);
-            }
+        const toToken = params.toToken.toLowerCase();
+        const outputTokenAddress = getTokenAddress(this.chainId, toToken);
+        const strategyAddress = params.strategyAddress?.startsWith('0x') ? params.strategyAddress : undefined;
 
-            const response = await fetch(url, {
-                headers: {
-                    'Content-Type': 'application/json',
-                    Accept: 'application/json',
-                },
-            });
+        const url = new URL(`${this.baseUrl}/quote/${outputTokenAddress}`);
+        if (strategyAddress) url.searchParams.append('strategy', strategyAddress);
+        if (params.amount) url.searchParams.append('satoshis', `${params.amount}`);
 
-            const quote: GatewayQuote = await response.json();
-            return {
-                ...quote,
-                fee: quote.fee + (params.gasRefill || 0),
-                baseToken: ADDRESS_LOOKUP[this.chainId][quote.baseTokenAddress],
-                outputToken: quote.strategyAddress ? ADDRESS_LOOKUP[this.chainId][outputTokenAddress] : undefined,
-            };
-        } else {
-            return this.fetchOfframpQuote(params.tokenAddress, params.amount);
-        }
+        const response = await fetch(url, {
+            headers: {
+                'Content-Type': 'application/json',
+                Accept: 'application/json',
+            },
+        });
+
+        const quote: GatewayQuote = await response.json();
+        return {
+            ...quote,
+            fee: quote.fee + (params.gasRefill || 0),
+            baseToken: ADDRESS_LOOKUP[this.chainId][quote.baseTokenAddress],
+            outputToken: quote.strategyAddress ? ADDRESS_LOOKUP[this.chainId][outputTokenAddress] : undefined,
+        };
     }
 
     /**
@@ -264,7 +268,7 @@ export class GatewayApiClient {
      * @param amountInToken Amount specified in token decimals.
      * @returns Offramp quote details.
      */
-    async fetchOfframpQuote(token: string, amountInToken: bigint): Promise<OfframpQuote> {
+    async fetchOfframpQuote(token: string, amountInToken: number): Promise<OfframpQuote> {
         const queryParams = new URLSearchParams({
             amountInWrappedToken: amountInToken.toString(),
             token,
@@ -322,7 +326,7 @@ export class GatewayApiClient {
     ): Promise<OfframpCreateOrderParams> {
         const tokenAddress = getTokenAddress(this.chainId, params.fromToken.toLowerCase());
 
-        const offrampQuote: OfframpQuote = await this.fetchOfframpQuote(tokenAddress, BigInt(params.amount));
+        const offrampQuote: OfframpQuote = await this.fetchOfframpQuote(tokenAddress, Number(params.amount));
 
         // get btc script pub key
         let bitcoinNetwork = bitcoin.networks.regtest;
@@ -481,7 +485,7 @@ export class GatewayApiClient {
 
         let offrampQuote: OfframpQuote;
         try {
-            offrampQuote = await this.fetchOfframpQuote(token.toString(), amountInToken);
+            offrampQuote = await this.fetchOfframpQuote(token.toString(), Number(amountInToken));
         } catch (err) {
             // Return false and 0n with an error message if fetching the quote fails
             return [false, 0n, `Error fetching offramp quote: ${err.message || err}`];

sdk/test/gateway.test.ts

@@ -904,4 +904,55 @@ describe('Gateway Tests', () => {
         expect(getOnrampOrdersSpy).toHaveBeenCalledOnce();
         expect(getOfframpOrdersSpy).toHaveBeenCalledOnce();
     });
+
+    it('test to check getQuote types', async () => {
+        const gatewaySDK = new GatewaySDK('mainnet');
+        const mockQuote = {
+            gatewayAddress: ZeroAddress,
+            baseTokenAddress: TBTC_ADDRESS,
+            dustThreshold: 1000,
+            satoshis: 1000,
+            fee: 10,
+            bitcoinAddress: '',
+            txProofDifficultyFactor: 3,
+            strategyAddress: ZeroAddress,
+            baseToken: TBTC,
+            outputToken: TBTC,
+        };
+        nock(`${MAINNET_GATEWAY_BASE_URL}`).get(`/quote/${TBTC_ADDRESS}?satoshis=1000`).times(5).reply(200, mockQuote);
+        const searchParams = new URLSearchParams({
+            amountInWrappedToken: '1000',
+            token: TBTC_ADDRESS,
+        });
+        nock(`${MAINNET_GATEWAY_BASE_URL}`).get(`/offramp-quote?${searchParams}`).reply(201, {
+            amountLockInSat: 1000,
+            feesInSat: 0,
+            feeRate: 0,
+            registryAddress: zeroAddress,
+        });
+
+        const result_onramp = await gatewaySDK.getQuote({
+            type: 'onramp',
+            params: {
+                toChain: 'BOB',
+                toToken: TBTC_ADDRESS,
+                toUserAddress: ZeroAddress,
+                amount: 1000,
+            },
+        });
+
+        // Optionally, print keys or typeof each field
+        console.log('Type keys offramp:', Object.keys(result_onramp));
+
+        const result_offramp = await gatewaySDK.getQuote({
+            type: 'offramp',
+            params: {
+                tokenAddress: TBTC_ADDRESS as Address,
+                amount: 1000,
+            },
+        });
+
+        // Optionally, print keys or typeof each field
+        console.log('Type keys offramp:', Object.keys(result_offramp));
+    });
 });