Merge pull request #221 from VeloraDEX/feat/bridge-price-shape

Feat/bridge price shape

Author: andriy-shymkiv

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@velora-dex/sdk",
-  "version": "9.3.0",
+  "version": "9.3.1",
   "main": "dist/index.js",
   "module": "dist/sdk.esm.js",
   "typings": "dist/index.d.ts",

src/index.ts

@@ -174,6 +174,7 @@ import {
   GetDeltaPriceFunctions,
   DeltaPrice,
   BridgePrice,
+  AvailableBridge,
   DeltaPriceParams,
 } from './methods/delta/getDeltaPrice';
 import {
@@ -379,6 +380,7 @@ export type {
   BridgeStatus,
   Bridge,
   BridgeInfo,
+  AvailableBridge,
   BridgeProtocolResponse,
   BuildDeltaOrderDataParams,
   BuildDeltaOrderFunctions,

src/methods/delta/getBridgeInfo.ts

@@ -31,6 +31,7 @@ type GetBridgeInfo = (
 export type BridgeProtocolResponse = {
   protocol: string;
   displayName: string;
+  icon: string;
 };
 
 type BridgeProtocolsResponse = {

src/methods/delta/getDeltaPrice.ts

@@ -1,3 +1,4 @@
+import { Prettify } from 'viem';
 import { Bridge } from '../..';
 import { API_URL, SwapSide } from '../../constants';
 import { constructSearchString } from '../../helpers/misc';
@@ -105,14 +106,15 @@ type AvailableBridgePrice = Pick<
   | 'gasCost'
   | 'gasCostUSDBeforeFee'
   | 'gasCostBeforeFee'
+  | 'receivedDestAmount'
+  | 'receivedDestAmountBeforeFee'
+  | 'receivedDestUSD'
+  | 'receivedDestUSDBeforeFee'
 >;
 
-type AvailableBridge = AvailableBridgePrice & {
-  bridgeParams: {
-    bridge: Bridge;
-    bridgeInfo: BridgePriceInfo;
-  }[];
-};
+export type AvailableBridge = Prettify<
+  AvailableBridgePrice & Pick<BridgePrice, 'bridge' | 'bridgeInfo'>
+>;
 
 export type BridgePrice = Omit<DeltaPrice, 'bridge'> & {
   // destAmountAfterBridge: string; // became bridgeInfo.destAmountAfterBridge

src/methods/delta/helpers/types.ts

@@ -151,4 +151,7 @@ export type BridgePriceInfo = {
   destUSDAfterBridge: string;
   fees: BridgeQuoteFee[];
   estimatedTimeMs: number;
+  fastest: boolean;
+  bestReturn: boolean;
+  recommended: boolean;
 };

src/methods/quote/getQuote.ts

@@ -29,6 +29,10 @@ export type QuoteParams<M extends TradeMode = TradeMode> = {
   userAddress?: string;
   /** @description Partner string */
   partner?: string;
+  /** @description Maximum price impact (in percentage) acceptable for the trade */
+  maxImpact?: number;
+  /** @description Maximum price impact (in USD) acceptable for the trade */
+  maxUSDImpact?: number;
   /** @description Preferred mode for the trade. In case of "all", Delta pricing is returned, with Market as a fallback */
   mode: M;
 };

src/methods/swap/adapters.ts

@@ -15,7 +15,7 @@ export type GetAdaptersFunctions = {
 };
 
 type SearchStringParams = {
-  network: number;
+  chainId: number;
   version?: APIVersion;
 };
 
@@ -30,7 +30,7 @@ export const constructGetAdapters = ({
   ): Promise<AdaptersAsStrings> => {
     // always pass explicit type to make sure UrlSearchParams are correct
     const query = constructSearchString<SearchStringParams>({
-      network: chainId,
+      chainId,
       version,
     });
 

src/methods/swap/rates.ts

@@ -42,9 +42,9 @@ type RateQueryParams = {
   side?: 'SELL' | 'BUY';
 
   /**
-   * @description Network ID. (Mainnet - 1, Optimism - 10, BSC - 56, Polygon - 137, Fantom - 250, zkEVM - 1101, Base - 8453, Arbitrum - 42161, Avalanche - 43114). Default: `1`.
+   * @description Chain ID. (Mainnet - 1, Optimism - 10, BSC - 56, Polygon - 137, Base - 8453, Arbitrum - 42161, Avalanche - 43114, Gnosis - 100, Unichain - 130, Sonic - 146). Default: `1`.
    */
-  network?: number;
+  chainId?: number;
 
   /**
    * @description If provided, **others** object is filled in the response with price quotes from other exchanges _(if available for comparison)_. Default: `false`.
@@ -221,7 +221,7 @@ export const constructGetRate = ({
     const search = constructSearchString<Omit<RateQueryParams, 'route'>>({
       srcToken,
       destToken,
-      network: chainId,
+      chainId,
       version,
       ...parsedOptions,
     });
@@ -253,7 +253,7 @@ export const constructGetRate = ({
       Omit<RateQueryParams, 'srcToken' | 'destToken'>
     >({
       route: _route, // route can be used in place of srcToken+destToken
-      network: chainId,
+      chainId,
       version,
       ...parsedOptions,
     });

src/methods/swap/spender.ts

@@ -36,8 +36,8 @@ export const constructGetSpender = ({
   chainId,
   fetcher,
 }: ConstructFetchInput): GetSpenderFunctions => {
-  const search = constructSearchString<{ network: number; version: string }>({
-    network: chainId,
+  const search = constructSearchString<{ chainId: number; version: string }>({
+    chainId,
     version,
   });
 

src/methods/swap/swapTx.ts

@@ -41,9 +41,9 @@ type SwapQueryParams = {
   side: 'SELL' | 'BUY';
 
   /**
-   * @description Network ID. (Mainnet - 1, Optimism - 10, BSC - 56, Polygon - 137, Fantom - 250, zkEVM - 1101, Base - 8453, Arbitrum - 42161, Avalanche - 43114). Default: `1`.
+   * @description Chain ID. (Mainnet - 1, Optimism - 10, BSC - 56, Polygon - 137, Base - 8453, Arbitrum - 42161, Avalanche - 43114, Gnosis - 100, Unichain - 130, Sonic - 146). Default: `1`.
    */
-  network?: number;
+  chainId?: number;
 
   /**
    * @description Comma Separated List of DEXs to include. **Supported DEXs:** Uniswap, Kyber, Bancor, AugustusRFQ, Oasis, Compound, Fulcrum, 0x, MakerDAO, Chai, Aave, Aave2, MultiPath, MegaPath, Curve, Curve3, Saddle, IronV2, BDai, idle, Weth, Beth, UniswapV2, Balancer, 0xRFQt, SushiSwap, LINKSWAP, Synthetix, DefiSwap, Swerve, CoFiX, Shell, DODOV1, DODOV2, OnChainPricing, PancakeSwap, PancakeSwapV2, ApeSwap, Wbnb, acryptos, streetswap, bakeryswap, julswap, vswap, vpegswap, beltfi, ellipsis, QuickSwap, COMETH, Wmatic, Nerve, Dfyn, UniswapV3, Smoothy, PantherSwap, OMM1, OneInchLP, CurveV2, mStable, WaultFinance, MDEX, ShibaSwap, CoinSwap, SakeSwap, JetSwap, Biswap, BProtocol eg: `UniswapV3,0x`.
@@ -179,7 +179,7 @@ type SwapTxInputListFields =
 
 type SwapRateOptions = Omit<
   SwapQueryParams,
-  SwapTxInputFields | SwapTxInputListFields | 'network' | 'version'
+  SwapTxInputFields | SwapTxInputListFields | 'chainId' | 'version'
 > & {
   /**
    * @description List of DEXs to include. **Supported DEXs:** Uniswap, Kyber, Bancor, AugustusRFQ, Oasis, Compound, Fulcrum, 0x, MakerDAO, Chai, Aave, Aave2, MultiPath, MegaPath, Curve, Curve3, Saddle, IronV2, BDai, idle, Weth, Beth, UniswapV2, Balancer, 0xRFQt, SushiSwap, LINKSWAP, Synthetix, DefiSwap, Swerve, CoFiX, Shell, DODOV1, DODOV2, OnChainPricing, PancakeSwap, PancakeSwapV2, ApeSwap, Wbnb, acryptos, streetswap, bakeryswap, julswap, vswap, vpegswap, beltfi, ellipsis, QuickSwap, COMETH, Wmatic, Nerve, Dfyn, UniswapV3, Smoothy, PantherSwap, OMM1, OneInchLP, CurveV2, mStable, WaultFinance, MDEX, ShibaSwap, CoinSwap, SakeSwap, JetSwap, Biswap, BProtocol eg: `UniswapV3,0x`.
@@ -244,7 +244,7 @@ export const constructSwapTx = ({
       srcToken,
       destToken,
       route: _route,
-      network: chainId,
+      chainId,
       version,
       ...parsedOptions,
     });