@velora-dex/sdk 9.3.0-dev.2 → 9.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@velora-dex/sdk",
-  "version": "9.3.0-dev.2",
+  "version": "9.3.1",
   "main": "dist/index.js",
   "module": "dist/sdk.esm.js",
   "typings": "dist/index.d.ts",
@@ -93,7 +93,7 @@
     }
   },
   "dependencies": {
-    "@paraswap/core": "2.4.0",
+    "@paraswap/core": "2.4.1",
     "ts-essentials": "^10.0.3",
     "viem": "^2.21.0"
   },

package/src/methods/delta/buildDeltaOrder.ts

@@ -65,6 +65,9 @@ export type BuildDeltaOrderDataParams = {
   /** @description take surplus */
   partnerTakesSurplus?: boolean;
 
+  /** @description A boolean indicating whether the surplus should be capped. True by default */
+  capSurplus?: boolean;
+
   /** @description The side of the order. Default is SELL */
   side?: SwapSideUnion;
   /** @description Metadata for the order, hex string */
@@ -164,6 +167,8 @@ export const constructBuildDeltaOrder = (
       partnerTakesSurplus,
       partnerFeeBps,
 
+      capSurplus: options.capSurplus,
+
       bridge: options.deltaPrice.bridge, // ZERO_BRIDGE for same-chain Orders
     };
 

package/src/methods/delta/getBridgeInfo.ts

@@ -31,7 +31,7 @@ type GetBridgeInfo = (
 export type BridgeProtocolResponse = {
   protocol: string;
   displayName: string;
-  icon: string; // CDN URL
+  icon: string;
 };
 
 type BridgeProtocolsResponse = {
@@ -58,7 +58,7 @@ export const constructGetBridgeInfo = ({
     const bridgesString = bridges ? bridges.join(',') : undefined;
 
     const search = constructSearchString<BridgeInfoQuery>({
-      allowBridgeAndSwap: !!allowBridgeAndSwap,
+      allowBridgeAndSwap,
       bridges: bridgesString,
     });
 

package/src/methods/delta/helpers/buildDeltaOrderData.ts

@@ -94,6 +94,7 @@ export type BuildDeltaOrderDataInput = MarkOptional<
   paraswapDeltaAddress: string;
   partnerFeeBps: number;
   partnerTakesSurplus?: boolean;
+  capSurplus?: boolean;
   chainId: number;
   bridge: Bridge;
 };
@@ -122,6 +123,7 @@ export function buildDeltaSignableOrderData({
   partnerAddress,
   partnerFeeBps,
   partnerTakesSurplus = false,
+  capSurplus = true,
 
   chainId,
   paraswapDeltaAddress,
@@ -142,6 +144,7 @@ export function buildDeltaSignableOrderData({
       partnerFeeBps,
       partnerAddress,
       partnerTakesSurplus,
+      capSurplus,
     }),
     bridge,
     kind,
@@ -159,6 +162,7 @@ type ProducePartnerAndFeeInput = {
   partnerFeeBps: number;
   partnerAddress: string;
   partnerTakesSurplus: boolean;
+  capSurplus: boolean;
 };
 
 // fee and address are encoded together
@@ -166,13 +170,18 @@ function producePartnerAndFee({
   partnerFeeBps,
   partnerAddress,
   partnerTakesSurplus,
+  capSurplus,
 }: ProducePartnerAndFeeInput): string {
-  if (partnerAddress === ZERO_ADDRESS) return '0';
-
-  const partnerAndFee =
-    (BigInt(partnerAddress) << BigInt(96)) |
-    BigInt(partnerFeeBps.toFixed(0)) |
-    (BigInt(partnerTakesSurplus) << BigInt(8));
-
-  return partnerAndFee.toString(10);
+  const capSurplusShifted = BigInt(capSurplus) << BigInt(9);
+  if (partnerAddress === ZERO_ADDRESS) {
+    return capSurplusShifted.toString(10);
+  } else {
+    const partnerAndFee =
+      (BigInt(partnerAddress) << BigInt(96)) |
+      BigInt(partnerFeeBps.toFixed(0)) |
+      (BigInt(partnerTakesSurplus) << BigInt(8)) |
+      capSurplusShifted;
+
+    return partnerAndFee.toString(10);
+  }
 }

package/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;
 };

package/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,
     });
 

package/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,
     });

package/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,
   });
 

package/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,
     });