@velora-dex/sdk
Version:
45 lines • 2.39 kB
TypeScript
import type { ConstructFetchInput, RequestParameters } from '../../types';
import type { DeltaAuctionOrder } from './helpers/types';
import type { BuiltDeltaOrder, DeltaRoute } from './types';
export type { BuiltDeltaOrder } from './types';
export type BuildDeltaOrderParams = {
/** @description The address of the order owner */
owner: string;
/** @description The address of the order beneficiary. Defaults to owner. */
beneficiary?: string;
/** @description The deadline for the order (unix seconds) */
deadline?: number;
/** @description The nonce of the order. Random if omitted. */
nonce?: string;
/** @description Optional permit signature for the src token. Defaults to "0x". */
permit?: string;
/** @description Partner string. Passed to the server to resolve partner fee details. */
partner?: string;
/** @description Partner fee in basis points (bps), 50bps=0.5% */
partnerFeeBps?: number;
/** @description Partner address */
partnerAddress?: string;
/** @description Take surplus flag */
partnerTakesSurplus?: boolean;
/** @description Whether the surplus should be capped. True by default. */
capSurplus?: boolean;
/** @description Metadata for the order, hex string */
metadata?: string;
/** @description Designates the Order as partially fillable instead of fill-or-kill. Default false. */
partiallyFillable?: boolean;
/** @description DeltaRoute from getDeltaPrice — either price.route or any price.alternatives[i] */
route: DeltaRoute;
/** @description Order side. SELL or BUY. */
side: 'SELL' | 'BUY';
/** @description Slippage in basis points (bps). 10000 = 100%, 50 = 0.5%. Default 0. */
slippage?: number;
/** @description If passed, the server will use this as SELL destAmount (as BUY srcAmount) and expectedAmount */
limitAmount?: string;
};
type BuildDeltaOrder = (buildOrderParams: BuildDeltaOrderParams, requestParams?: RequestParameters) => Promise<BuiltDeltaOrder<DeltaAuctionOrder>>;
export type BuildDeltaOrderFunctions = {
/** @description Build a Delta v2 order from a DeltaRoute via the server endpoint, ready to sign and post. */
buildDeltaOrder: BuildDeltaOrder;
};
export declare const constructBuildDeltaOrder: (options: ConstructFetchInput) => BuildDeltaOrderFunctions;
//# sourceMappingURL=buildDeltaOrder.d.ts.map