@velora-dex/sdk
Version:
46 lines • 2 kB
TypeScript
import { SwapSide } from '../../constants';
import type { ConstructFetchInput, EnumerateLiteral, RequestParameters } from '../../types';
import type { DeltaPrice } from './types';
type SwapSideUnion = EnumerateLiteral<typeof SwapSide>;
export type DeltaPriceParams = {
/** @description Source Token Address */
srcToken: string;
/** @description Destination Token Address. For Crosschain Orders, the destination token on the destination chain */
destToken: string;
/** @description srcToken amount in wei */
amount: string;
/** @description Source Token Decimals */
srcDecimals: number;
/** @description Destination Token Decimals */
destDecimals: number;
/** @description User's Wallet Address */
userAddress?: string;
/** @description Beneficiary Address */
beneficiary?: string;
/** @description Partner string. */
partner?: string;
/** @description Partner fee in basis points (bps), 50bps=0.5% */
partnerFeeBps?: number;
/** @description Destination Chain ID for Crosschain Orders */
destChainId?: number;
/** @description SELL or BUY, default is SELL */
side?: SwapSideUnion;
/** @description In %. Bypasses the API price impact check (default = 15%) */
maxImpact?: number;
maxUSDImpact?: number;
includeAgents?: string[];
excludeAgents?: string[];
includeBridges?: string[];
excludeBridges?: string[];
/** @description Allow swap on destChain after bridge. Default is true. */
allowBridgeAndSwap?: boolean;
degenMode?: boolean;
};
type GetDeltaPrice = (options: DeltaPriceParams, requestParams?: RequestParameters) => Promise<DeltaPrice>;
export type GetDeltaPriceFunctions = {
/** @description Fetch a v2 price quote (route-based response). */
getDeltaPrice: GetDeltaPrice;
};
export declare const constructGetDeltaPrice: ({ apiURL, chainId, fetcher, }: ConstructFetchInput) => GetDeltaPriceFunctions;
export {};
//# sourceMappingURL=getDeltaPrice.d.ts.map