Merge pull request #172 from paraswap/feat/swap_endpoint

Feat/swap endpoint

Author: Velenir

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paraswap/sdk",
-  "version": "6.9.1",
+  "version": "6.10.0",
   "main": "dist/index.js",
   "module": "dist/sdk.esm.js",
   "typings": "dist/index.d.ts",

src/index.ts

@@ -17,6 +17,7 @@ import {
   GetAdaptersFunctions,
 } from './methods/swap/adapters';
 import { constructGetRate, GetRateFunctions } from './methods/swap/rates';
+import { constructSwapTx, GetSwapTxFunctions } from './methods/swap/swapTx';
 import { constructGetTokens, GetTokensFunctions } from './methods/swap/token';
 import { BuildTxFunctions, constructBuildTx } from './methods/swap/transaction';
 
@@ -170,6 +171,7 @@ export {
   constructBuildTx,
   constructGetAdapters,
   constructGetRate,
+  constructSwapTx,
   // limitOrders methods:
   constructBuildLimitOrder,
   constructSignLimitOrder,
@@ -213,6 +215,7 @@ export type {
   GetAdaptersFunctions,
   GetRateFunctions,
   BuildTxFunctions,
+  GetSwapTxFunctions,
   // types for limitOrders methods:
   BuildLimitOrderFunctions,
   SignLimitOrderFunctions,

src/methods/swap/helpers/normalizeRateOptions.ts

@@ -0,0 +1,61 @@
+import type { PickKeys } from 'ts-essentials';
+import type { RateOptions } from '../rates';
+
+type StringArrKeys = PickKeys<RateOptions, string[] | undefined>;
+
+type MinRateOptionsInput = Pick<RateOptions, StringArrKeys> &
+  Pick<RateOptions, 'partner'>;
+
+type NormalizedRateOptions<
+  O extends MinRateOptionsInput,
+  T extends { options?: Partial<O> }
+> = Partial<Record<StringArrKeys | 'partner', string>> &
+  Partial<Omit<O, StringArrKeys | 'partner'>> &
+  Omit<T, 'options'>;
+
+const DEFAULT_PARTNER = 'paraswap.io';
+
+export function normalizeRateOptions<
+  O extends MinRateOptionsInput,
+  T extends { options?: Partial<O> }
+>({ options = {}, ...restInput }: T): NormalizedRateOptions<O, T> {
+  const {
+    excludePricingMethods,
+    excludeContractMethods,
+    includeContractMethods,
+    partner = DEFAULT_PARTNER,
+    includeDEXS,
+    excludeDEXS,
+    excludePools,
+    ...restOptions
+  } = options;
+
+  const [
+    _includeDEXS,
+    _excludeDEXS,
+    _excludePools,
+    _excludePricingMethods,
+    _excludeContractMethods,
+    _includeContractMethods,
+  ] = [
+    includeDEXS,
+    excludeDEXS,
+    excludePools,
+    excludePricingMethods,
+    excludeContractMethods,
+    includeContractMethods,
+    //                                                                                              no "" empty string
+  ].map((array) => array?.join(',') || undefined);
+
+  const transformed: Partial<Record<StringArrKeys | 'partner', string>> = {
+    excludePricingMethods: _excludePricingMethods,
+    excludeContractMethods: _excludeContractMethods,
+    includeContractMethods: _includeContractMethods,
+    partner,
+    includeDEXS: _includeDEXS,
+    excludeDEXS: _excludeDEXS,
+    excludePools: _excludePools,
+  };
+
+  return { ...transformed, ...restOptions, ...restInput };
+}

src/methods/swap/index.ts

@@ -5,6 +5,7 @@ import { ApproveTokenFunctions, constructApproveToken } from './approve';
 import { constructGetBalances, GetBalancesFunctions } from './balance';
 import { constructGetRate, GetRateFunctions } from './rates';
 import { constructGetSpender, GetSpenderFunctions } from './spender';
+import { constructSwapTx, GetSwapTxFunctions } from './swapTx';
 import { constructGetTokens, GetTokensFunctions } from './token';
 import { BuildTxFunctions, constructBuildTx } from './transaction';
 
@@ -14,7 +15,8 @@ export type SwapSDKMethods<TxResponse> = GetBalancesFunctions &
   ApproveTokenFunctions<TxResponse> &
   BuildTxFunctions &
   GetAdaptersFunctions &
-  GetRateFunctions;
+  GetRateFunctions &
+  GetSwapTxFunctions;
 
 /** @description construct SDK with every Swap-related method, fetching from API and token approval */
 export const constructSwapSDK = <TxResponse>(
@@ -31,5 +33,6 @@ export const constructSwapSDK = <TxResponse>(
     ) => ApproveTokenFunctions<TxResponse>, // @TODO try Instantiation Expression when TS 4.7 `as constructApproveToken<TxResponse>`
     constructBuildTx,
     constructGetAdapters,
-    constructGetRate
+    constructGetRate,
+    constructSwapTx
   );