@velora-dex/sdk 9.2.0 → 9.3.0-dev.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@velora-dex/sdk",
-  "version": "9.2.0",
+  "version": "9.3.0-dev.1",
   "main": "dist/index.js",
   "module": "dist/sdk.esm.js",
   "typings": "dist/index.d.ts",
@@ -49,19 +49,19 @@
     }
   ],
   "devDependencies": {
-    "@size-limit/preset-small-lib": "^11.1.6",
+    "@size-limit/preset-small-lib": "^12.0.0",
     "@tsconfig/recommended": "^1.0.8",
-    "axios": "^1.7.7",
+    "axios": "^1.13.2",
     "bignumber.js": "^9.1.2",
     "dotenv": "^16.4.5",
     "dts-cli": "^2.0.5",
     "ethers": "^6.13.4",
     "ethersV5": "npm:ethers@5",
-    "hardhat": "^2.22.15",
-    "hardhat-switch-network": "^1.1.1",
+    "hardhat": "^2.28.0",
+    "hardhat-switch-network": "^1.2.1",
     "husky": "^9.1.6",
     "isomorphic-unfetch": "^4.0.2",
-    "size-limit": "^11.1.6",
+    "size-limit": "^12.0.0",
     "tslib": "^2.8.1",
     "typedoc": "^0.26.11",
     "typedoc-plugin-markdown": "^4.2.10",

package/src/methods/delta/getBridgeInfo.ts

@@ -1,4 +1,5 @@
 import { API_URL } from '../../constants';
+import { constructSearchString } from '../../helpers/misc';
 import type {
   Address,
   ConstructFetchInput,
@@ -10,21 +11,61 @@ import type {
 export type BridgeInfo = Record<number, Record<number, Address[]>>;
 type BridgeInfoResponse = { supportedTokens: BridgeInfo };
 
-type GetBridgeInfo = (requestParams?: RequestParameters) => Promise<BridgeInfo>;
+type GetBridgeInfoParams = {
+  /** @description Include tokens that can be swapped on destChain after bridge. Default is true. */
+  allowBridgeAndSwap?: boolean;
+  /** @description Include only the specified bridges. Default is all bridges. */
+  bridges?: string[];
+};
+
+type BridgeInfoQuery = {
+  allowBridgeAndSwap?: string;
+  bridges?: string;
+};
+
+type GetBridgeInfo = (
+  params?: GetBridgeInfoParams,
+  requestParams?: RequestParameters
+) => Promise<BridgeInfo>;
+
+type BridgeProtocolResponse = {
+  protocol: string;
+  displayName: string;
+};
+
+type BridgeProtocolsResponse = {
+  bridgeProtocols: BridgeProtocolResponse[];
+};
+
+type GetBridgeProtocols = (
+  requestParams?: RequestParameters
+) => Promise<BridgeProtocolResponse[]>;
 
 export type GetBridgeInfoFunctions = {
   getBridgeInfo: GetBridgeInfo;
+  getBridgeProtocols: GetBridgeProtocols;
 };
 
 export const constructGetBridgeInfo = ({
   apiURL = API_URL,
   fetcher,
 }: ConstructFetchInput): GetBridgeInfoFunctions => {
-  const bridgeInfoUrl = `${apiURL}/delta/prices/bridge-info` as const;
+  const deltaBridgeUrl = `${apiURL}/delta/prices` as const;
+
+  const getBridgeInfo: GetBridgeInfo = async (params = {}, requestParams) => {
+    const { allowBridgeAndSwap, bridges } = params;
+    const allowBridgeAndSwapString = allowBridgeAndSwap ? 'true' : 'false';
+    const bridgesString = bridges ? bridges.join(',') : undefined;
+
+    const search = constructSearchString<BridgeInfoQuery>({
+      allowBridgeAndSwap: allowBridgeAndSwapString,
+      bridges: bridgesString,
+    });
+
+    const fetchURL = `${deltaBridgeUrl}/bridge-info${search}` as const;
 
-  const getBridgeInfo: GetBridgeInfo = async (requestParams) => {
     const data = await fetcher<BridgeInfoResponse>({
-      url: bridgeInfoUrl,
+      url: fetchURL,
       method: 'GET',
       requestParams,
     });
@@ -32,7 +73,20 @@ export const constructGetBridgeInfo = ({
     return data.supportedTokens;
   };
 
+  const getBridgeProtocols: GetBridgeProtocols = async (requestParams) => {
+    const fetchURL = `${deltaBridgeUrl}/bridge-protocols` as const;
+
+    const data = await fetcher<BridgeProtocolsResponse>({
+      url: fetchURL,
+      method: 'GET',
+      requestParams,
+    });
+
+    return data.bridgeProtocols;
+  };
+
   return {
     getBridgeInfo,
+    getBridgeProtocols,
   };
 };

package/src/methods/delta/getDeltaPrice.ts

@@ -35,15 +35,22 @@ export type DeltaPriceParams = {
 
   includeAgents?: string[];
   excludeAgents?: string[];
+  includeBridges?: string[];
+  excludeBridges?: string[];
+
+  /** @description Allow swap on destChain after bridge. Default is true. */
+  allowBridgeAndSwap?: boolean;
 };
 
 type DeltaPriceQueryOptions = Omit<
   DeltaPriceParams,
-  'includeAgents' | 'excludeAgents'
+  'includeAgents' | 'excludeAgents' | 'includeBridges' | 'excludeBridges'
 > & {
   chainId: number; // will return error from API on unsupported chains
   includeAgents?: string;
   excludeAgents?: string;
+  includeBridges?: string;
+  excludeBridges?: string;
 };
 
 // for same-chain Orders, all 0 params
@@ -91,9 +98,9 @@ type AvailableBridgePrice = Pick<
   DeltaPrice,
   | 'destToken'
   | 'destAmount'
-  | 'destAmountBeforeFee'
+  | 'destAmountBeforeFee' // Available for SELL side
   | 'destUSD'
-  | 'destUSDBeforeFee'
+  | 'destUSDBeforeFee' // Available for SELL side
   | 'gasCostUSD'
   | 'gasCost'
   | 'gasCostUSDBeforeFee'
@@ -164,13 +171,25 @@ export const constructGetDeltaPrice = ({
     options: DeltaPriceParams,
     requestParams?: RequestParameters
   ): Promise<DeltaPrice | BridgePrice> {
-    const { includeAgents, excludeAgents, ...rest } = options;
+    const {
+      includeAgents,
+      excludeAgents,
+      includeBridges,
+      excludeBridges,
+      ...rest
+    } = options;
     const includeAgentsString = includeAgents
       ? includeAgents.join(',')
       : undefined;
     const excludeAgentsString = excludeAgents
       ? excludeAgents.join(',')
       : undefined;
+    const includeBridgesString = includeBridges
+      ? includeBridges.join(',')
+      : undefined;
+    const excludeBridgesString = excludeBridges
+      ? excludeBridges.join(',')
+      : undefined;
 
     const search = constructSearchString<DeltaPriceQueryOptions>({
       ...rest,
@@ -178,6 +197,8 @@ export const constructGetDeltaPrice = ({
       side: options.side ?? SwapSide.SELL,
       includeAgents: includeAgentsString,
       excludeAgents: excludeAgentsString,
+      includeBridges: includeBridgesString,
+      excludeBridges: excludeBridgesString,
     });
 
     const fetchURL = `${pricesUrl}/${search}` as const;

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

@@ -138,20 +138,6 @@ export type BridgeStatus = 'pending' | 'filled' | 'expired' | 'refunded';
 
 //// available on BridgePrice ////
 
-// so far
-type ProtocolName =
-  | 'Across'
-  | 'StargateBus'
-  | 'StargateTaxi'
-  | 'StargateOftV2'
-  | 'Relay'
-  | 'CCTPFast'
-  | 'CCTPStandard'
-  | 'Celer'
-  | 'Canonical'
-  | 'Polygon'
-  | 'Arbitrum';
-
 type BridgeQuoteFee = {
   feeToken: string;
   amount: string;
@@ -160,7 +146,7 @@ type BridgeQuoteFee = {
 };
 
 export type BridgePriceInfo = {
-  protocolName: ProtocolName;
+  protocolName: string;
   destAmountAfterBridge: string;
   destUSDAfterBridge: string;
   fees: BridgeQuoteFee[];