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

package/package.json

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

package/src/index.ts

@@ -174,6 +174,7 @@ import {
   GetDeltaPriceFunctions,
   DeltaPrice,
   BridgePrice,
+  AvailableBridge,
   DeltaPriceParams,
 } from './methods/delta/getDeltaPrice';
 import {
@@ -194,6 +195,7 @@ import {
   constructGetBridgeInfo,
   GetBridgeInfoFunctions,
   BridgeInfo,
+  BridgeProtocolResponse,
 } from './methods/delta/getBridgeInfo';
 import {
   constructIsTokenSupportedInDelta,
@@ -378,6 +380,8 @@ export type {
   BridgeStatus,
   Bridge,
   BridgeInfo,
+  AvailableBridge,
+  BridgeProtocolResponse,
   BuildDeltaOrderDataParams,
   BuildDeltaOrderFunctions,
   SignableDeltaOrderData,

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?: boolean;
+  bridges?: string;
+};
+
+type GetBridgeInfo = (
+  params?: GetBridgeInfoParams,
+  requestParams?: RequestParameters
+) => Promise<BridgeInfo>;
+
+export type BridgeProtocolResponse = {
+  protocol: string;
+  displayName: string;
+  icon: string; // CDN URL
+};
+
+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 bridgesString = bridges ? bridges.join(',') : undefined;
+
+    const search = constructSearchString<BridgeInfoQuery>({
+      allowBridgeAndSwap: !!allowBridgeAndSwap,
+      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/getDeltaOrders.ts

@@ -7,7 +7,7 @@ import type {
 } from '../../types';
 import type { DeltaAuction, DeltaAuctionStatus } from './helpers/types';
 
-export type DeltaOrderFromAPI = Omit<DeltaAuction, 'signature' | 'cosignature'>;
+export type DeltaOrderFromAPI = Omit<DeltaAuction, 'signature'>;
 
 export type DeltaOrderFilterByStatus =
   | DeltaAuctionStatus

package/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';
@@ -39,7 +40,7 @@ export type DeltaPriceParams = {
   excludeBridges?: string[];
 
   /** @description Allow swap on destChain after bridge. Default is true. */
-  allowBridgeSwap?: boolean;
+  allowBridgeAndSwap?: boolean;
 };
 
 type DeltaPriceQueryOptions = Omit<
@@ -98,21 +99,22 @@ type AvailableBridgePrice = Pick<
   DeltaPrice,
   | 'destToken'
   | 'destAmount'
-  | 'destAmountBeforeFee'
+  | 'destAmountBeforeFee' // Available for SELL side
   | 'destUSD'
-  | 'destUSDBeforeFee'
+  | 'destUSDBeforeFee' // Available for SELL side
   | 'gasCostUSD'
   | '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

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

@@ -95,7 +95,6 @@ export type DeltaAuction = {
   deltaVersion: string; // 1.0 or 2.0 currently
   user: string;
   signature: string;
-  cosignature: string; // added for Crosschain Orders after bridge
   status: DeltaAuctionStatus;
   order: DeltaAuctionOrder;
   orderHash: string | null; // not available on old Orders only
@@ -139,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;
@@ -161,9 +146,12 @@ type BridgeQuoteFee = {
 };
 
 export type BridgePriceInfo = {
-  protocolName: ProtocolName;
+  protocolName: string;
   destAmountAfterBridge: string;
   destUSDAfterBridge: string;
   fees: BridgeQuoteFee[];
   estimatedTimeMs: number;
+  fastest: boolean;
+  bestReturn: boolean;
+  recommended: boolean;
 };

package/src/methods/delta/postDeltaOrder.ts

@@ -27,7 +27,6 @@ export type DeltaOrderApiResponse = Omit<DeltaAuction, 'transactions'> & {
   orderVersion: string; // "2.0.0"
   deltaGasOverhead: number; // @TODO may be removed
   type: 'MARKET' | 'LIMIT';
-  cosignature: '0x';
 };
 
 type PostDeltaOrder = (