@switch-win/sdk 1.2.2 → 1.2.4

package/src/types.ts

@@ -25,9 +25,10 @@ export interface BestPathResponse {
   receiver?: string;
   /** Total input amount in wei */
   totalAmountIn: string;
-  /**
-   * Raw DEX output in wei -- reflects price impact only.
-   * This is the amount the pools would return before any taxes, fees, or slippage are applied.
+  /**
+   * Quoted route output in wei before the Switch protocol fee and slippage.
+   * Adapter-native quotes may already include token-tax effects (for example,
+   * the Flap Portal quote).
    */
   totalAmountOut: string;
   /**
@@ -39,18 +40,17 @@ export interface BestPathResponse {
    * multipliers to `totalAmountOut`.
    */
   expectedOutputAmount: string;
-  /**
-   * Minimum acceptable output after taxes, fee, and slippage.
-   *
-   * Calculated as:
-   * `totalAmountOut -- (1 -- sellTax) -- (1 -- fee) -- (1 -- buyTax) -- (1 -- slippage)`
-   *
-   * This is the value encoded in the `tx` calldata as `_minTotalAmountOut`.
+  /**
+   * Minimum acceptable output after taxes, fee, and slippage.
+   *
+   * Tax accounting is adapter-specific. Use this API value directly rather
+   * than recomputing it from the reported tax rates. This is encoded in the
+   * `tx` calldata as `_minTotalAmountOut`.
    */
   minAmountOut: string;
   /** Human-readable path descriptions */
   paths: SwapPath[];
-  /** Structured route breakdown (matches on-chain structs) */
+  /** Human-readable structured route breakdown for display and analytics. */
   routeAllocation?: RouteAllocationPlan;
   /** Ready-to-send transaction with fee on **input** (default). Only present when `sender` query param is provided. */
   tx?: SwapTransaction;
@@ -159,7 +159,7 @@ export interface SwapPathLeg {
   percentage?: number;
 }
 
-// -- Route allocation (matches on-chain structs) --
+// -- Human-readable route allocation --
 
 /** Top-level route allocation plan */
 export interface RouteAllocationPlan {
@@ -192,14 +192,16 @@ export interface HopAllocationPlan {
 }
 
 /** A single adapter leg within a hop */
-export interface HopAdapterAllocationPlan {
-  /** DEX adapter contract address */
-  adapter: string;
+export interface HopAdapterAllocationPlan {
+  /** Human-readable DEX adapter name */
+  adapter: string;
   /** Input amount routed through this adapter (wei) */
   amountIn: string;
-  /** Expected output from this adapter (wei) */
-  amountOut: string;
-}
+  /** Expected output from this adapter (wei) */
+  amountOut: string;
+  /** V3 fee tier or concentrated-liquidity tick-spacing hint. Zero for adapters that do not use it. */
+  fee?: number;
+}
 
 // -- Error response --
 
@@ -312,18 +314,24 @@ export interface LimitOrderParams {
  * A signed limit order — the order parameters plus the EIP-712 signature.
  * This is what gets submitted to the Switch backend via `POST /limit-orders`.
  */
-export interface SignedLimitOrder extends LimitOrderParams {
-  /** EIP-712 signature of the order struct, produced by the maker's wallet */
-  signature: string;
-}
+export interface SignedLimitOrder extends LimitOrderParams {
+  /** EIP-712 signature of the order struct, produced by the maker's wallet */
+  signature: string;
+  /**
+   * SwitchLimitOrder deployment used in the EIP-712 domain.
+   * Include this when submitting Robinhood orders or orders signed against an
+   * older supported deployment so the backend verifies the correct domain.
+   */
+  limitOrderContract?: string;
+}
 
 // -- API request/response types --
 
 /** Body for `POST /limit-orders` */
 export type CreateLimitOrderRequest = SignedLimitOrder;
 
-/** Body for `DELETE /limit-orders` */
-export interface CancelLimitOrderRequest {
+/** @deprecated Current hosted API cancellation is on-chain only. */
+export interface CancelLimitOrderRequest {
   /** Maker address */
   maker: string;
   /** Nonce of the order to cancel */
@@ -359,7 +367,7 @@ export interface LimitOrderRecord {
   nonce: number;
   /** Fee mode flag */
   feeOnOutput: boolean;
-  /** Unwrap output to native PLS flag */
+  /** Unwrap wrapped-native output to PLS/ETH on the selected network */
   unwrapOutput: boolean;
   /** Partner address for fee sharing */
   partnerAddress: string;
@@ -399,8 +407,8 @@ export interface CreateLimitOrderResponse {
   order: LimitOrderRecord;
 }
 
-/** Response from `DELETE /limit-orders` (success) */
-export interface CancelLimitOrderResponse {
+/** @deprecated Current hosted API cancellation is on-chain only. */
+export interface CancelLimitOrderResponse {
   success: true;
 }
 
@@ -429,13 +437,29 @@ export interface LimitOrderPair {
 }
 
 /** Response from `GET /limit-orders/stats` */
-export interface LimitOrderStats {
+export interface LimitOrderStats {
   active: number;
   filled: number;
   cancelled: number;
   expired: number;
   total: number;
-}
+}
+
+/** Response from `GET /limit-orders/config`. */
+export interface LimitOrderConfigResponse {
+  limitOrderContract: string;
+  allLimitOrderContracts: string[];
+  plsFlowContract: string | null;
+  allPlsFlowContracts: string[];
+  limitOrderContractVersions: Record<string, string>;
+  plsFlowContractVersions: Record<string, string>;
+  eip712Domain: {
+    name: "SwitchLimitOrder";
+    version: "2";
+    chainId: number;
+    verifyingContract: string;
+  };
+}
 
 /** Union type for limit order mutation responses */
 export type LimitOrderMutationResponse =