@compass-labs/api-sdk 2.2.112-rc.1 → 2.2.113

package/src/models/components/earnswapresponse.ts

@@ -5,6 +5,7 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
@@ -16,6 +17,20 @@ import {
   UnsignedTransaction$inboundSchema,
 } from "./unsignedtransaction.js";
 
+/**
+ * Which route priced the swap. 'market': a DEX aggregator, slippage-bounded. 'firm': a zero-slippage quote that fills exactly or reverts. Always present; this is the authoritative signal, since `pricing` is only what was requested.
+ */
+export const EarnSwapResponseSwapProvider = {
+  Market: "market",
+  Firm: "firm",
+} as const;
+/**
+ * Which route priced the swap. 'market': a DEX aggregator, slippage-bounded. 'firm': a zero-slippage quote that fills exactly or reverts. Always present; this is the authoritative signal, since `pricing` is only what was requested.
+ */
+export type EarnSwapResponseSwapProvider = ClosedEnum<
+  typeof EarnSwapResponseSwapProvider
+>;
+
 export type EarnSwapResponse = {
   /**
    * Unsigned transaction for direct execution. Present when gas_sponsorship=false.
@@ -26,11 +41,24 @@ export type EarnSwapResponse = {
    */
   eip712?: BatchedSafeOperationsResponseOutput | null | undefined;
   /**
-   * Estimated amount of output token received from the swap.
+   * Estimated amount of output token received from the swap. Exact on firm builds (a firm quote fills at this amount or reverts); a quote-time estimate on market builds, where `slippage` sets how far below it the enforced minimum output sits.
    */
   estimatedAmountOut: string;
+  /**
+   * Which route priced the swap. 'market': a DEX aggregator, slippage-bounded. 'firm': a zero-slippage quote that fills exactly or reverts. Always present; this is the authoritative signal, since `pricing` is only what was requested.
+   */
+  swapProvider?: EarnSwapResponseSwapProvider | undefined;
+  /**
+   * Deadline of the firm swap quote. The transaction (or the sponsor's broadcast of the signed typed data) must be included before it or the swap reverts on-chain; refresh by re-calling this endpoint and discarding the previous payload. Null on market builds.
+   */
+  quoteExpiresAt?: Date | null | undefined;
 };
 
+/** @internal */
+export const EarnSwapResponseSwapProvider$inboundSchema: z.ZodNativeEnum<
+  typeof EarnSwapResponseSwapProvider
+> = z.nativeEnum(EarnSwapResponseSwapProvider);
+
 /** @internal */
 export const EarnSwapResponse$inboundSchema: z.ZodType<
   EarnSwapResponse,
@@ -41,10 +69,16 @@ export const EarnSwapResponse$inboundSchema: z.ZodType<
   eip_712: z.nullable(BatchedSafeOperationsResponseOutput$inboundSchema)
     .optional(),
   estimated_amount_out: z.string(),
+  swap_provider: EarnSwapResponseSwapProvider$inboundSchema.optional(),
+  quote_expires_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
 }).transform((v) => {
   return remap$(v, {
     "eip_712": "eip712",
     "estimated_amount_out": "estimatedAmountOut",
+    "swap_provider": "swapProvider",
+    "quote_expires_at": "quoteExpiresAt",
   });
 });
 

package/src/models/components/v2bundleresponse.ts

@@ -5,6 +5,7 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
@@ -16,6 +17,14 @@ import {
   UnsignedTransaction$inboundSchema,
 } from "./unsignedtransaction.js";
 
+export const V2BundleResponseSwapProvider = {
+  Market: "market",
+  Firm: "firm",
+} as const;
+export type V2BundleResponseSwapProvider = ClosedEnum<
+  typeof V2BundleResponseSwapProvider
+>;
+
 export type V2BundleResponse = {
   /**
    * Unsigned transaction for direct execution by the owner. Present when gas_sponsorship=false.
@@ -29,8 +38,21 @@ export type V2BundleResponse = {
    * Number of individual transactions bundled in this execution.
    */
   actionsCount: number;
+  /**
+   * Which route priced the bundle's V2_SWAP action(s): 'market' (a DEX aggregator, slippage-bounded) or 'firm' (a zero-slippage quote that fills exactly or reverts; the only route on HyperEVM). Null when the bundle carries no swap.
+   */
+  swapProvider?: V2BundleResponseSwapProvider | null | undefined;
+  /**
+   * Deadline of the firm swap quote inside the bundle. The transaction (or the sponsor's broadcast of the signed typed data) must be included before it or the bundle reverts on-chain; rebuild after it passes. Null unless a swap action was firm-priced.
+   */
+  quoteExpiresAt?: Date | null | undefined;
 };
 
+/** @internal */
+export const V2BundleResponseSwapProvider$inboundSchema: z.ZodNativeEnum<
+  typeof V2BundleResponseSwapProvider
+> = z.nativeEnum(V2BundleResponseSwapProvider);
+
 /** @internal */
 export const V2BundleResponse$inboundSchema: z.ZodType<
   V2BundleResponse,
@@ -41,10 +63,17 @@ export const V2BundleResponse$inboundSchema: z.ZodType<
   eip_712: z.nullable(BatchedSafeOperationsResponseOutput$inboundSchema)
     .optional(),
   actions_count: z.number().int(),
+  swap_provider: z.nullable(V2BundleResponseSwapProvider$inboundSchema)
+    .optional(),
+  quote_expires_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
 }).transform((v) => {
   return remap$(v, {
     "eip_712": "eip712",
     "actions_count": "actionsCount",
+    "swap_provider": "swapProvider",
+    "quote_expires_at": "quoteExpiresAt",
   });
 });
 

package/src/sdk/earn.ts

@@ -147,8 +147,11 @@ export class Earn extends ClientSDK {
    * Estimate the output of a swap without building a transaction.
    *
    * Returns the expected amount of `token_out` received for selling `amount_in`
-   * of `token_in`, routed via 1inch. This is read-only: it does not build a
-   * transaction, require an account, or check balances.
+   * of `token_in`. On chains with a market route this is the market rate; on
+   * HyperEVM, where swaps are firm-priced, it is an indicative price from the
+   * firm provider's live levels (`swap_provider` tells you which). This is
+   * read-only: it does not build a transaction, require an account, or check
+   * balances.
    *
    * Use it to gauge exit liquidity and price impact for a token before entering
    * a position — for example, to warn when a market's underlying asset cannot be