@compass-labs/api-sdk 2.2.93 → 2.2.95-rc.0

package/openapi_prepped_for_speakeasy.json

@@ -5905,6 +5905,7 @@
                 "base",
                 "bsc",
                 "ethereum",
+                "hyperevm",
                 "tempo"
               ],
               "title": "Chain",
@@ -5968,6 +5969,7 @@
                 "base",
                 "bsc",
                 "ethereum",
+                "hyperevm",
                 "tempo"
               ],
               "title": "Chain",
@@ -6031,6 +6033,7 @@
                 "base",
                 "bsc",
                 "ethereum",
+                "hyperevm",
                 "tempo"
               ],
               "title": "Chain",
@@ -6094,6 +6097,7 @@
                 "base",
                 "bsc",
                 "ethereum",
+                "hyperevm",
                 "tempo"
               ],
               "title": "Chain",
@@ -6170,6 +6174,7 @@
                 "base",
                 "bsc",
                 "ethereum",
+                "hyperevm",
                 "tempo"
               ],
               "title": "Chain",
@@ -12258,6 +12263,7 @@
               "base",
               "bsc",
               "ethereum",
+              "hyperevm",
               "tempo"
             ],
             "title": "Chain",
@@ -12521,7 +12527,16 @@
             "example": "0xfeEb60eBf707DAA8248277058eb8D28EaeCF5425"
           },
           "chain": {
-            "$ref": "#/components/schemas/Chain",
+            "type": "string",
+            "enum": [
+              "arbitrum",
+              "base",
+              "bsc",
+              "ethereum",
+              "hyperevm",
+              "tempo"
+            ],
+            "title": "Chain",
             "description": "Blockchain network.",
             "example": "base"
           },
@@ -12803,7 +12818,16 @@
             "description": "The owner's wallet address that controls the Credit Account."
           },
           "chain": {
-            "$ref": "#/components/schemas/Chain",
+            "type": "string",
+            "enum": [
+              "arbitrum",
+              "base",
+              "bsc",
+              "ethereum",
+              "hyperevm",
+              "tempo"
+            ],
+            "title": "Chain",
             "description": "Target blockchain network where the bundled actions will execute."
           },
           "actions": {
@@ -13047,6 +13071,11 @@
             "title": "Estimated Max Dust",
             "description": "Upper bound of collateral-token surplus the swaps can leave in the Credit Account (sum of quote \u2212 guaranteed floor per swap). It is bounded by max_slippage_percent per iteration, stays in the account, and is never lost."
           },
+          "estimated_swap_cost": {
+            "type": "string",
+            "title": "Estimated Swap Cost",
+            "description": "Expected one-off cost of entering this loop, in COLLATERAL token units: the sum over swap legs of the market oracle's fair output minus the router's quote. This is the DEX fee plus price impact \u2014 the amount the position must earn back before it is ahead. Multiply by the collateral price for a USD figure. Distinct from estimated_max_dust, which is surplus retained in the account, not a cost. Excludes gas. Measured against the protocol's own oracle, so it also carries any oracle-to-market basis; clamped at zero."
+          },
           "legs": {
             "items": {
               "$ref": "#/components/schemas/LoopLegPreview"
@@ -13066,7 +13095,8 @@
           "achieved_multiplier",
           "projected_ltv",
           "projected_health_factor",
-          "estimated_max_dust"
+          "estimated_max_dust",
+          "estimated_swap_cost"
         ],
         "title": "CreditLoopPreview",
         "description": "Projected end state of the loop, computed on GUARANTEED swap floors."
@@ -13080,7 +13110,16 @@
             "example": "0x5e5b00ed886A6879C2B934612D2312975427fcAf"
           },
           "chain": {
-            "$ref": "#/components/schemas/Chain",
+            "type": "string",
+            "enum": [
+              "arbitrum",
+              "base",
+              "bsc",
+              "ethereum",
+              "hyperevm",
+              "tempo"
+            ],
+            "title": "Chain",
             "description": "Blockchain network.",
             "example": "ethereum"
           },
@@ -13482,8 +13521,16 @@
             "example": "0x4D3c07d1db7E4A9E44285fae9810d6549655bc74"
           },
           "chain": {
-            "$ref": "#/components/schemas/Chain",
-            "description": "Blockchain network.",
+            "type": "string",
+            "enum": [
+              "arbitrum",
+              "base",
+              "bsc",
+              "ethereum",
+              "tempo"
+            ],
+            "title": "Chain",
+            "description": "Blockchain network. Rebalance is not available on HyperEVM yet; use loop/unloop there.",
             "example": "ethereum"
           },
           "targets": {
@@ -13672,7 +13719,16 @@
             "example": "0x831Ad0C52C77708DA5D49dc8278C966dfdD4ddA1"
           },
           "chain": {
-            "$ref": "#/components/schemas/Chain",
+            "type": "string",
+            "enum": [
+              "arbitrum",
+              "base",
+              "bsc",
+              "ethereum",
+              "hyperevm",
+              "tempo"
+            ],
+            "title": "Chain",
             "description": "Blockchain network.",
             "example": "base"
           },
@@ -14002,7 +14058,16 @@
             "example": "0x4A83fec8c6A9A25Be28f3242a16dBaD0ab00f3a6"
           },
           "chain": {
-            "$ref": "#/components/schemas/Chain",
+            "type": "string",
+            "enum": [
+              "arbitrum",
+              "base",
+              "bsc",
+              "ethereum",
+              "hyperevm",
+              "tempo"
+            ],
+            "title": "Chain",
             "description": "Blockchain network.",
             "example": "base"
           },
@@ -14233,7 +14298,16 @@
             "example": "0x0E407CdeBD8e078E6966ef6740540d25F5897082"
           },
           "chain": {
-            "$ref": "#/components/schemas/Chain",
+            "type": "string",
+            "enum": [
+              "arbitrum",
+              "base",
+              "bsc",
+              "ethereum",
+              "hyperevm",
+              "tempo"
+            ],
+            "title": "Chain",
             "description": "Blockchain network.",
             "example": "ethereum"
           },
@@ -16670,6 +16744,18 @@
             ],
             "title": "Min Swap Out",
             "description": "Guaranteed swap output (collateral units) \u2014 the next iteration's supply. Enforced on-chain by the swap's minimum-return."
+          },
+          "expected_swap_out": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Expected Swap Out",
+            "description": "Quoted swap output (collateral units) before the slippage floor is applied. Only min_swap_out is guaranteed on-chain; the gap between the two is the adverse-slippage tolerance, bounded by max_slippage_percent, not a surplus that is certain to arrive. Whatever the fill actually delivers above min_swap_out stays in the account, and estimated_max_dust is the upper bound on that."
           }
         },
         "additionalProperties": false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "2.2.93",
+  "version": "2.2.95-rc.0",
   "author": "royalnine",
   "type": "module",
   "tshy": {

package/src/models/components/createcreditaccountrequest.ts

@@ -11,6 +11,7 @@ export const CreateCreditAccountRequestChain = {
   Base: "base",
   Bsc: "bsc",
   Ethereum: "ethereum",
+  Hyperevm: "hyperevm",
   Tempo: "tempo",
 } as const;
 export type CreateCreditAccountRequestChain = ClosedEnum<

package/src/models/components/creditborrowrequest.ts

@@ -4,7 +4,7 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
-import { Chain, Chain$outboundSchema } from "./chain.js";
+import { ClosedEnum } from "../../types/enums.js";
 import {
   CreditFee,
   CreditFee$Outbound,
@@ -19,6 +19,24 @@ import {
   InterestRateMode$outboundSchema,
 } from "./interestratemode.js";
 
+/**
+ * Blockchain network.
+ */
+export const CreditBorrowRequestChain = {
+  Arbitrum: "arbitrum",
+  Base: "base",
+  Bsc: "bsc",
+  Ethereum: "ethereum",
+  Hyperevm: "hyperevm",
+  Tempo: "tempo",
+} as const;
+/**
+ * Blockchain network.
+ */
+export type CreditBorrowRequestChain = ClosedEnum<
+  typeof CreditBorrowRequestChain
+>;
+
 /**
  * Amount of token_in to use (in token units, not wei). Omit together with token_in and collateral_token for borrow-only mode.
  */
@@ -40,9 +58,9 @@ export type CreditBorrowRequest = {
    */
   owner: string;
   /**
-   * The chain to use.
+   * Blockchain network.
    */
-  chain: Chain;
+  chain: CreditBorrowRequestChain;
   /**
    * Which lending protocol a credit action targets.
    *
@@ -126,6 +144,11 @@ export type CreditBorrowRequest = {
   permit2Deadline?: number | null | undefined;
 };
 
+/** @internal */
+export const CreditBorrowRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof CreditBorrowRequestChain
+> = z.nativeEnum(CreditBorrowRequestChain);
+
 /** @internal */
 export type CreditBorrowRequestAmountIn$Outbound = number | string;
 
@@ -210,7 +233,7 @@ export const CreditBorrowRequest$outboundSchema: z.ZodType<
   CreditBorrowRequest
 > = z.object({
   owner: z.string(),
-  chain: Chain$outboundSchema,
+  chain: CreditBorrowRequestChain$outboundSchema,
   protocol: CreditProtocol$outboundSchema.optional(),
   collateralVault: z.nullable(z.string()).optional(),
   borrowVault: z.nullable(z.string()).optional(),

package/src/models/components/creditbundlerequest.ts

@@ -4,13 +4,31 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
-import { Chain, Chain$outboundSchema } from "./chain.js";
+import { ClosedEnum } from "../../types/enums.js";
 import {
   CreditUserOperation,
   CreditUserOperation$Outbound,
   CreditUserOperation$outboundSchema,
 } from "./credituseroperation.js";
 
+/**
+ * Target blockchain network where the bundled actions will execute.
+ */
+export const CreditBundleRequestChain = {
+  Arbitrum: "arbitrum",
+  Base: "base",
+  Bsc: "bsc",
+  Ethereum: "ethereum",
+  Hyperevm: "hyperevm",
+  Tempo: "tempo",
+} as const;
+/**
+ * Target blockchain network where the bundled actions will execute.
+ */
+export type CreditBundleRequestChain = ClosedEnum<
+  typeof CreditBundleRequestChain
+>;
+
 /**
  * Request to execute multiple credit actions in a single atomic transaction.
  */
@@ -20,9 +38,9 @@ export type CreditBundleRequest = {
    */
   owner: string;
   /**
-   * The chain to use.
+   * Target blockchain network where the bundled actions will execute.
    */
-  chain: Chain;
+  chain: CreditBundleRequestChain;
   /**
    * List of actions to bundle. Actions are executed in order.
    */
@@ -33,6 +51,11 @@ export type CreditBundleRequest = {
   gasSponsorship?: boolean | undefined;
 };
 
+/** @internal */
+export const CreditBundleRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof CreditBundleRequestChain
+> = z.nativeEnum(CreditBundleRequestChain);
+
 /** @internal */
 export type CreditBundleRequest$Outbound = {
   owner: string;
@@ -48,7 +71,7 @@ export const CreditBundleRequest$outboundSchema: z.ZodType<
   CreditBundleRequest
 > = z.object({
   owner: z.string(),
-  chain: Chain$outboundSchema,
+  chain: CreditBundleRequestChain$outboundSchema,
   actions: z.array(CreditUserOperation$outboundSchema),
   gasSponsorship: z.boolean().optional(),
 }).transform((v) => {

package/src/models/components/creditlooppreview.ts

@@ -44,6 +44,10 @@ export type CreditLoopPreview = {
    * Upper bound of collateral-token surplus the swaps can leave in the Credit Account (sum of quote − guaranteed floor per swap). It is bounded by max_slippage_percent per iteration, stays in the account, and is never lost.
    */
   estimatedMaxDust: string;
+  /**
+   * Expected one-off cost of entering this loop, in COLLATERAL token units: the sum over swap legs of the market oracle's fair output minus the router's quote. This is the DEX fee plus price impact — the amount the position must earn back before it is ahead. Multiply by the collateral price for a USD figure. Distinct from estimated_max_dust, which is surplus retained in the account, not a cost. Excludes gas. Measured against the protocol's own oracle, so it also carries any oracle-to-market basis; clamped at zero.
+   */
+  estimatedSwapCost: string;
   /**
    * Per-iteration breakdown.
    */
@@ -63,6 +67,7 @@ export const CreditLoopPreview$inboundSchema: z.ZodType<
   projected_ltv: z.string(),
   projected_health_factor: z.string(),
   estimated_max_dust: z.string(),
+  estimated_swap_cost: z.string(),
   legs: z.array(LoopLegPreview$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
@@ -72,6 +77,7 @@ export const CreditLoopPreview$inboundSchema: z.ZodType<
     "projected_ltv": "projectedLtv",
     "projected_health_factor": "projectedHealthFactor",
     "estimated_max_dust": "estimatedMaxDust",
+    "estimated_swap_cost": "estimatedSwapCost",
   });
 });
 

package/src/models/components/creditlooprequest.ts

@@ -4,12 +4,28 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
-import { Chain, Chain$outboundSchema } from "./chain.js";
+import { ClosedEnum } from "../../types/enums.js";
 import {
   CreditProtocol,
   CreditProtocol$outboundSchema,
 } from "./creditprotocol.js";
 
+/**
+ * Blockchain network.
+ */
+export const CreditLoopRequestChain = {
+  Arbitrum: "arbitrum",
+  Base: "base",
+  Bsc: "bsc",
+  Ethereum: "ethereum",
+  Hyperevm: "hyperevm",
+  Tempo: "tempo",
+} as const;
+/**
+ * Blockchain network.
+ */
+export type CreditLoopRequestChain = ClosedEnum<typeof CreditLoopRequestChain>;
+
 /**
  * Collateral (in token units) already held in the Credit Account to seed the loop.
  */
@@ -43,9 +59,9 @@ export type CreditLoopRequest = {
    */
   owner: string;
   /**
-   * The chain to use.
+   * Blockchain network.
    */
-  chain: Chain;
+  chain: CreditLoopRequestChain;
   /**
    * Which lending protocol a credit action targets.
    *
@@ -109,6 +125,11 @@ export type CreditLoopRequest = {
   gasSponsorship?: boolean | undefined;
 };
 
+/** @internal */
+export const CreditLoopRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof CreditLoopRequestChain
+> = z.nativeEnum(CreditLoopRequestChain);
+
 /** @internal */
 export type CreditLoopRequestInitialCollateralAmount$Outbound = number | string;
 
@@ -216,7 +237,7 @@ export const CreditLoopRequest$outboundSchema: z.ZodType<
   CreditLoopRequest
 > = z.object({
   owner: z.string(),
-  chain: Chain$outboundSchema,
+  chain: CreditLoopRequestChain$outboundSchema,
   protocol: CreditProtocol$outboundSchema.optional(),
   marketId: z.nullable(z.string()).optional(),
   collateralVault: z.nullable(z.string()).optional(),

package/src/models/components/creditrebalancerequest.ts

@@ -4,13 +4,30 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
-import { Chain, Chain$outboundSchema } from "./chain.js";
+import { ClosedEnum } from "../../types/enums.js";
 import {
   RebalanceTarget,
   RebalanceTarget$Outbound,
   RebalanceTarget$outboundSchema,
 } from "./rebalancetarget.js";
 
+/**
+ * Blockchain network. Rebalance is not available on HyperEVM yet; use loop/unloop there.
+ */
+export const CreditRebalanceRequestChain = {
+  Arbitrum: "arbitrum",
+  Base: "base",
+  Bsc: "bsc",
+  Ethereum: "ethereum",
+  Tempo: "tempo",
+} as const;
+/**
+ * Blockchain network. Rebalance is not available on HyperEVM yet; use loop/unloop there.
+ */
+export type CreditRebalanceRequestChain = ClosedEnum<
+  typeof CreditRebalanceRequestChain
+>;
+
 /**
  * Request-level per-swap slippage tolerance in percent (including routing swaps). A per-target max_slippage_percent overrides it where set.
  */
@@ -30,9 +47,9 @@ export type CreditRebalanceRequest = {
    */
   owner: string;
   /**
-   * The chain to use.
+   * Blockchain network. Rebalance is not available on HyperEVM yet; use loop/unloop there.
    */
-  chain: Chain;
+  chain: CreditRebalanceRequestChain;
   /**
    * The positions to change. Scoped: only positions named here are touched; any position not listed is left untouched.
    */
@@ -47,6 +64,11 @@ export type CreditRebalanceRequest = {
   gasSponsorship?: boolean | undefined;
 };
 
+/** @internal */
+export const CreditRebalanceRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof CreditRebalanceRequestChain
+> = z.nativeEnum(CreditRebalanceRequestChain);
+
 /** @internal */
 export type CreditRebalanceRequestMaxSlippagePercent$Outbound = number | string;
 
@@ -84,7 +106,7 @@ export const CreditRebalanceRequest$outboundSchema: z.ZodType<
   CreditRebalanceRequest
 > = z.object({
   owner: z.string(),
-  chain: Chain$outboundSchema,
+  chain: CreditRebalanceRequestChain$outboundSchema,
   targets: z.array(RebalanceTarget$outboundSchema),
   maxSlippagePercent: z.union([z.number(), z.string()]).optional(),
   gasSponsorship: z.boolean().optional(),

package/src/models/components/creditrepayrequest.ts

@@ -4,7 +4,7 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
-import { Chain, Chain$outboundSchema } from "./chain.js";
+import { ClosedEnum } from "../../types/enums.js";
 import {
   CreditProtocol,
   CreditProtocol$outboundSchema,
@@ -14,6 +14,24 @@ import {
   InterestRateMode$outboundSchema,
 } from "./interestratemode.js";
 
+/**
+ * Blockchain network.
+ */
+export const CreditRepayRequestChain = {
+  Arbitrum: "arbitrum",
+  Base: "base",
+  Bsc: "bsc",
+  Ethereum: "ethereum",
+  Hyperevm: "hyperevm",
+  Tempo: "tempo",
+} as const;
+/**
+ * Blockchain network.
+ */
+export type CreditRepayRequestChain = ClosedEnum<
+  typeof CreditRepayRequestChain
+>;
+
 /**
  * Amount of repay_token to repay (in token units, not wei).
  */
@@ -35,9 +53,9 @@ export type CreditRepayRequest = {
    */
   owner: string;
   /**
-   * The chain to use.
+   * Blockchain network.
    */
-  chain: Chain;
+  chain: CreditRepayRequestChain;
   /**
    * Which lending protocol a credit action targets.
    *
@@ -117,6 +135,11 @@ export type CreditRepayRequest = {
   permit2Deadline?: number | null | undefined;
 };
 
+/** @internal */
+export const CreditRepayRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof CreditRepayRequestChain
+> = z.nativeEnum(CreditRepayRequestChain);
+
 /** @internal */
 export type RepayAmount$Outbound = number | string;
 
@@ -192,7 +215,7 @@ export const CreditRepayRequest$outboundSchema: z.ZodType<
   CreditRepayRequest
 > = z.object({
   owner: z.string(),
-  chain: Chain$outboundSchema,
+  chain: CreditRepayRequestChain$outboundSchema,
   protocol: CreditProtocol$outboundSchema.optional(),
   borrowVault: z.nullable(z.string()).optional(),
   marketId: z.nullable(z.string()).optional(),

package/src/models/components/credittransferrequest.ts

@@ -5,7 +5,24 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { ClosedEnum } from "../../types/enums.js";
-import { Chain, Chain$outboundSchema } from "./chain.js";
+
+/**
+ * Blockchain network.
+ */
+export const CreditTransferRequestChain = {
+  Arbitrum: "arbitrum",
+  Base: "base",
+  Bsc: "bsc",
+  Ethereum: "ethereum",
+  Hyperevm: "hyperevm",
+  Tempo: "tempo",
+} as const;
+/**
+ * Blockchain network.
+ */
+export type CreditTransferRequestChain = ClosedEnum<
+  typeof CreditTransferRequestChain
+>;
 
 /**
  * The amount of tokens to transfer (in token units, not wei).
@@ -32,9 +49,9 @@ export type CreditTransferRequest = {
    */
   owner: string;
   /**
-   * The chain to use.
+   * Blockchain network.
    */
-  chain: Chain;
+  chain: CreditTransferRequestChain;
   /**
    * The token to transfer.
    */
@@ -57,6 +74,11 @@ export type CreditTransferRequest = {
   spender?: string | null | undefined;
 };
 
+/** @internal */
+export const CreditTransferRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof CreditTransferRequestChain
+> = z.nativeEnum(CreditTransferRequestChain);
+
 /** @internal */
 export type CreditTransferRequestAmount$Outbound = number | string;
 
@@ -100,7 +122,7 @@ export const CreditTransferRequest$outboundSchema: z.ZodType<
   CreditTransferRequest
 > = z.object({
   owner: z.string(),
-  chain: Chain$outboundSchema,
+  chain: CreditTransferRequestChain$outboundSchema,
   token: z.string(),
   amount: z.union([z.number(), z.string()]),
   action: CreditTransferRequestAction$outboundSchema,