@switch-win/sdk 1.2.9 → 1.3.0

package/src/types.ts

@@ -25,10 +25,10 @@ export interface BestPathResponse {
   receiver?: string;
   /** Total input amount in wei */
   totalAmountIn: string;
-  /**
-   * 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).
+  /**
+   * 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;
   /**
@@ -40,17 +40,17 @@ export interface BestPathResponse {
    * multipliers to `totalAmountOut`.
    */
   expectedOutputAmount: string;
-  /**
-   * 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`.
+  /**
+   * 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[];
-  /** Human-readable structured route breakdown for display and analytics. */
+  /** 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;
@@ -62,6 +62,15 @@ export interface BestPathResponse {
    * the output token). See the README for recommended strategies.
    */
   txFeeOnOutput?: SwapTransaction;
+  /** Transaction matching the requested fee mode. Never broadcast this for a gasless order. */
+  selectedTx?: SwapTransaction;
+  protocolFeeBps?: number;
+  feeOnOutput?: boolean;
+  quoteGasPrice?: string;
+  quoteBlockNumber?: number;
+  gaslessExecution?: import("./gasless-types.js").GaslessPreviewResult;
+  /** Conservative server recommendation; normal quotes report not_checked. */
+  gaslessEligibility?: import("./gasless-types.js").GaslessEligibility;
   /**
    * Transfer tax info for the input token.
    * Present when the API detects whether the token has a fee-on-transfer mechanism.
@@ -116,8 +125,8 @@ export interface SwapTransaction {
   to: string;
   /** ABI-encoded `goSwitch()` calldata */
   data: string;
-  /** Native currency to send (wei). `"0"` for ERC-20 input tokens. */
-  value: string;
+  /** Native currency to send (wei). `"0"` for ERC-20 input tokens. */
+  value: string;
 }
 
 // -- Human-readable paths --
@@ -159,7 +168,7 @@ export interface SwapPathLeg {
   percentage?: number;
 }
 
-// -- Human-readable route allocation --
+// -- Human-readable route allocation --
 
 /** Top-level route allocation plan */
 export interface RouteAllocationPlan {
@@ -192,16 +201,16 @@ export interface HopAllocationPlan {
 }
 
 /** A single adapter leg within a hop */
-export interface HopAdapterAllocationPlan {
-  /** Human-readable DEX adapter name */
-  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;
-  /** V3 fee tier or concentrated-liquidity tick-spacing hint. Zero for adapters that do not use it. */
-  fee?: number;
-}
+  /** 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 --
 
@@ -314,24 +323,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;
-  /**
-   * 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;
-}
+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;
 
-/** @deprecated Current hosted API cancellation is on-chain only. */
-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 */
@@ -367,7 +376,7 @@ export interface LimitOrderRecord {
   nonce: number;
   /** Fee mode flag */
   feeOnOutput: boolean;
-  /** Unwrap wrapped-native output to PLS/ETH on the selected network */
+  /** Unwrap wrapped-native output to PLS/ETH on the selected network */
   unwrapOutput: boolean;
   /** Partner address for fee sharing */
   partnerAddress: string;
@@ -407,8 +416,8 @@ export interface CreateLimitOrderResponse {
   order: LimitOrderRecord;
 }
 
-/** @deprecated Current hosted API cancellation is on-chain only. */
-export interface CancelLimitOrderResponse {
+/** @deprecated Current hosted API cancellation is on-chain only. */
+export interface CancelLimitOrderResponse {
   success: true;
 }
 
@@ -437,29 +446,45 @@ 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;
-  };
-}
+}
+
+/** Response from `GET /limit-orders/config`. */
+export interface LimitOrderConfigResponse {
+  limitOrderContract: string;
+  limitOrderRouter?: string | null;
+  gaslessContract?: string | null;
+  gaslessSettlementVersion?: number;
+  gaslessTaxTokensSupported?: boolean;
+  gaslessApprovalSpender?: string | null;
+  gaslessProtocolFeeBps?: number;
+  gaslessMaxOperatorPayoutBps?: number;
+  gaslessEip712Domain?: {
+    name: string;
+    version: string;
+    chainId: number;
+    verifyingContract: string;
+  } | null;
+  orderSubmissionLimitOrderContracts?: string[];
+  otcRoutingLimitOrderContracts?: string[];
+  deprecatedLimitOrderContracts?: 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 =