@compass-labs/api-sdk 2.2.70 → 2.2.71-rc.0

package/openapi_prepped_for_speakeasy.json

@@ -9734,6 +9734,11 @@
       },
       "AccountSummary": {
         "properties": {
+          "protocol": {
+            "$ref": "#/components/schemas/CreditProtocol",
+            "description": "Lending protocol this summary describes.",
+            "example": "AAVE"
+          },
           "health_factor": {
             "type": "string",
             "title": "Health Factor",
@@ -9788,7 +9793,7 @@
           "ltv"
         ],
         "title": "AccountSummary",
-        "description": "Aave account-level summary from getUserAccountData()."
+        "description": "Account-level summary for one lending protocol.\n\nPopulated from Aave ``getUserAccountData()`` or, for Euler, from the\ncontroller vault's risk engine (``accountLiquidity``). The E-Mode fields are\nAave-only and stay at their defaults for Euler."
       },
       "AerodromeEnrichedPosition": {
         "properties": {
@@ -11497,6 +11502,23 @@
             "title": "Symbol",
             "description": "Symbol of the collateral token (e.g. USDC)."
           },
+          "protocol": {
+            "$ref": "#/components/schemas/CreditProtocol",
+            "description": "Lending protocol this position belongs to.",
+            "example": "AAVE"
+          },
+          "vault": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Vault",
+            "description": "Euler only: the EVK collateral vault holding this position."
+          },
           "amount_supplied": {
             "anyOf": [
               {
@@ -11507,7 +11529,7 @@
               }
             ],
             "title": "Amount Supplied",
-            "description": "Current on-chain aToken balance for the collateral."
+            "description": "Current on-chain collateral balance (the vault's underlying asset for Euler)."
           },
           "usd_value": {
             "anyOf": [
@@ -11925,6 +11947,23 @@
               }
             ],
             "description": "Optional fee on the borrowed amount."
+          },
+          "protocol": {
+            "$ref": "#/components/schemas/CreditProtocol",
+            "description": "Lending protocol to use. Defaults to Aave.",
+            "example": "AAVE"
+          },
+          "borrow_vault": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Borrow Vault",
+            "description": "Euler only: the EVK vault to borrow from. Required when protocol=EULER."
           }
         },
         "type": "object",
@@ -11948,6 +11987,35 @@
             "description": "Blockchain network.",
             "example": "base"
           },
+          "protocol": {
+            "$ref": "#/components/schemas/CreditProtocol",
+            "description": "Lending protocol to use. Defaults to Aave.",
+            "example": "AAVE"
+          },
+          "collateral_vault": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Collateral Vault",
+            "description": "Euler only: the EVK collateral vault to supply into. Required when protocol=EULER and supplying collateral."
+          },
+          "borrow_vault": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Borrow Vault",
+            "description": "Euler only: the EVK vault to borrow from. Required when protocol=EULER."
+          },
           "token_in": {
             "anyOf": [
               {
@@ -12254,6 +12322,23 @@
             "type": "string",
             "title": "Token",
             "description": "The underlying reserve token to enable as collateral (e.g. USDC, not aUSDC)."
+          },
+          "protocol": {
+            "$ref": "#/components/schemas/CreditProtocol",
+            "description": "Lending protocol to use. Defaults to Aave.",
+            "example": "AAVE"
+          },
+          "collateral_vault": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Collateral Vault",
+            "description": "Euler only: the EVK collateral vault to enable. Required when protocol=EULER."
           }
         },
         "type": "object",
@@ -12383,6 +12468,17 @@
             "$ref": "#/components/schemas/AccountSummary",
             "description": "Aave account-level summary (health factor, LTV, etc.)."
           },
+          "euler_account_summary": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/AccountSummary"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "Euler account-level summary (health factor, LTV, etc.), present only when the account holds Euler positions. Null for Aave-only accounts."
+          },
           "borrowable_tokens": {
             "items": {
               "$ref": "#/components/schemas/BorrowableToken"
@@ -12412,6 +12508,15 @@
         "title": "CreditPositionsResponse",
         "description": "Credit account positions response with per-reserve positions and account summary."
       },
+      "CreditProtocol": {
+        "type": "string",
+        "enum": [
+          "AAVE",
+          "EULER"
+        ],
+        "title": "CreditProtocol",
+        "description": "Which lending protocol a credit action targets.\n\n``AAVE`` is the default so existing callers (which never send a ``protocol``\nfield) keep hitting the unchanged Aave code path. ``EULER`` opts in to the\nEuler V2 path, where the market is identified by EVK vault address(es)."
+      },
       "CreditRepayParams": {
         "properties": {
           "action_type": {
@@ -12423,7 +12528,7 @@
           "token": {
             "type": "string",
             "title": "Token",
-            "description": "Token to repay to Aave."
+            "description": "Token to repay."
           },
           "amount": {
             "anyOf": [
@@ -12443,6 +12548,23 @@
             "$ref": "#/components/schemas/InterestRateMode",
             "description": "Interest rate mode: STABLE or VARIABLE.",
             "example": "variable"
+          },
+          "protocol": {
+            "$ref": "#/components/schemas/CreditProtocol",
+            "description": "Lending protocol to use. Defaults to Aave.",
+            "example": "AAVE"
+          },
+          "borrow_vault": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Borrow Vault",
+            "description": "Euler only: the EVK vault the debt is owed to. Required when protocol=EULER."
           }
         },
         "type": "object",
@@ -12466,6 +12588,35 @@
             "description": "Blockchain network.",
             "example": "base"
           },
+          "protocol": {
+            "$ref": "#/components/schemas/CreditProtocol",
+            "description": "Lending protocol to use. Defaults to Aave.",
+            "example": "AAVE"
+          },
+          "borrow_vault": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Borrow Vault",
+            "description": "Euler only: the EVK vault the debt is owed to (repay target). Required when protocol=EULER."
+          },
+          "collateral_vault": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Collateral Vault",
+            "description": "Euler only: the EVK collateral vault to withdraw from. Required when protocol=EULER and withdrawing collateral."
+          },
           "repay_token": {
             "type": "string",
             "title": "Token",
@@ -12672,7 +12823,7 @@
           "token": {
             "type": "string",
             "title": "Token",
-            "description": "Collateral token to supply to Aave."
+            "description": "Collateral token to supply."
           },
           "amount": {
             "anyOf": [
@@ -12687,6 +12838,23 @@
             ],
             "title": "Amount",
             "description": "Amount in token units to supply."
+          },
+          "protocol": {
+            "$ref": "#/components/schemas/CreditProtocol",
+            "description": "Lending protocol to use. Defaults to Aave.",
+            "example": "AAVE"
+          },
+          "collateral_vault": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Collateral Vault",
+            "description": "Euler only: the EVK collateral vault to supply into. Required when protocol=EULER."
           }
         },
         "type": "object",
@@ -12915,7 +13083,7 @@
           "token": {
             "type": "string",
             "title": "Token",
-            "description": "Collateral token to withdraw from Aave."
+            "description": "Collateral token to withdraw."
           },
           "amount": {
             "anyOf": [
@@ -12930,6 +13098,23 @@
             ],
             "title": "Amount",
             "description": "Amount in token units to withdraw."
+          },
+          "protocol": {
+            "$ref": "#/components/schemas/CreditProtocol",
+            "description": "Lending protocol to use. Defaults to Aave.",
+            "example": "AAVE"
+          },
+          "collateral_vault": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Collateral Vault",
+            "description": "Euler only: the EVK collateral vault to withdraw from. Required when protocol=EULER."
           }
         },
         "type": "object",
@@ -12952,6 +13137,23 @@
             "title": "Symbol",
             "description": "Symbol of the borrow token (e.g. WETH)."
           },
+          "protocol": {
+            "$ref": "#/components/schemas/CreditProtocol",
+            "description": "Lending protocol this position belongs to.",
+            "example": "AAVE"
+          },
+          "vault": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Vault",
+            "description": "Euler only: the EVK borrow vault this debt is owed to."
+          },
           "amount_borrowed": {
             "anyOf": [
               {
@@ -12962,7 +13164,7 @@
               }
             ],
             "title": "Amount Borrowed",
-            "description": "Current on-chain variable debt balance."
+            "description": "Current on-chain debt balance (the vault's underlying asset for Euler)."
           },
           "usd_value": {
             "anyOf": [

package/package.json

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

package/src/models/components/accountsummary.ts

@@ -7,11 +7,31 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CreditProtocol,
+  CreditProtocol$inboundSchema,
+} from "./creditprotocol.js";
 
 /**
- * Aave account-level summary from getUserAccountData().
+ * Account-level summary for one lending protocol.
+ *
+ * @remarks
+ *
+ * Populated from Aave ``getUserAccountData()`` or, for Euler, from the
+ * controller vault's risk engine (``accountLiquidity``). The E-Mode fields are
+ * Aave-only and stay at their defaults for Euler.
  */
 export type AccountSummary = {
+  /**
+   * Which lending protocol a credit action targets.
+   *
+   * @remarks
+   *
+   * ``AAVE`` is the default so existing callers (which never send a ``protocol``
+   * field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the
+   * Euler V2 path, where the market is identified by EVK vault address(es).
+   */
+  protocol?: CreditProtocol | undefined;
   /**
    * Health factor. Above 1 is safe; below 1 risks liquidation.
    */
@@ -48,6 +68,7 @@ export const AccountSummary$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  protocol: CreditProtocol$inboundSchema.optional(),
   health_factor: z.string(),
   total_collateral_usd: z.string(),
   total_debt_usd: z.string(),

package/src/models/components/collateralposition.ts

@@ -8,6 +8,10 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { CreditEvent, CreditEvent$inboundSchema } from "./creditevent.js";
+import {
+  CreditProtocol,
+  CreditProtocol$inboundSchema,
+} from "./creditprotocol.js";
 
 /**
  * A per-reserve collateral position.
@@ -22,7 +26,21 @@ export type CollateralPosition = {
    */
   symbol: string;
   /**
-   * Current on-chain aToken balance for the collateral.
+   * Which lending protocol a credit action targets.
+   *
+   * @remarks
+   *
+   * ``AAVE`` is the default so existing callers (which never send a ``protocol``
+   * field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the
+   * Euler V2 path, where the market is identified by EVK vault address(es).
+   */
+  protocol?: CreditProtocol | undefined;
+  /**
+   * Euler only: the EVK collateral vault holding this position.
+   */
+  vault?: string | null | undefined;
+  /**
+   * Current on-chain collateral balance (the vault's underlying asset for Euler).
    */
   amountSupplied: string | null;
   /**
@@ -63,6 +81,8 @@ export const CollateralPosition$inboundSchema: z.ZodType<
 > = z.object({
   token: z.string(),
   symbol: z.string(),
+  protocol: CreditProtocol$inboundSchema.optional(),
+  vault: z.nullable(z.string()).optional(),
   amount_supplied: z.nullable(z.string()),
   usd_value: z.nullable(z.string()).optional(),
   supply_apy: z.nullable(z.string()).optional(),

package/src/models/components/creditborrowparams.ts

@@ -9,6 +9,10 @@ import {
   CreditFee$Outbound,
   CreditFee$outboundSchema,
 } from "./creditfee.js";
+import {
+  CreditProtocol,
+  CreditProtocol$outboundSchema,
+} from "./creditprotocol.js";
 import {
   InterestRateMode,
   InterestRateMode$outboundSchema,
@@ -44,6 +48,20 @@ export type CreditBorrowParams = {
    * Optional fee on the borrowed amount.
    */
   fee?: CreditFee | null | undefined;
+  /**
+   * Which lending protocol a credit action targets.
+   *
+   * @remarks
+   *
+   * ``AAVE`` is the default so existing callers (which never send a ``protocol``
+   * field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the
+   * Euler V2 path, where the market is identified by EVK vault address(es).
+   */
+  protocol?: CreditProtocol | undefined;
+  /**
+   * Euler only: the EVK vault to borrow from. Required when protocol=EULER.
+   */
+  borrowVault?: string | null | undefined;
 };
 
 /** @internal */
@@ -71,6 +89,8 @@ export type CreditBorrowParams$Outbound = {
   amount: number | string;
   interest_rate_mode?: string | undefined;
   fee?: CreditFee$Outbound | null | undefined;
+  protocol?: string | undefined;
+  borrow_vault?: string | null | undefined;
 };
 
 /** @internal */
@@ -84,10 +104,13 @@ export const CreditBorrowParams$outboundSchema: z.ZodType<
   amount: z.union([z.number(), z.string()]),
   interestRateMode: InterestRateMode$outboundSchema.optional(),
   fee: z.nullable(CreditFee$outboundSchema).optional(),
+  protocol: CreditProtocol$outboundSchema.optional(),
+  borrowVault: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     actionType: "action_type",
     interestRateMode: "interest_rate_mode",
+    borrowVault: "borrow_vault",
   });
 });
 

package/src/models/components/creditborrowrequest.ts

@@ -10,6 +10,10 @@ import {
   CreditFee$Outbound,
   CreditFee$outboundSchema,
 } from "./creditfee.js";
+import {
+  CreditProtocol,
+  CreditProtocol$outboundSchema,
+} from "./creditprotocol.js";
 import {
   InterestRateMode,
   InterestRateMode$outboundSchema,
@@ -39,6 +43,24 @@ export type CreditBorrowRequest = {
    * The chain to use.
    */
   chain: Chain;
+  /**
+   * Which lending protocol a credit action targets.
+   *
+   * @remarks
+   *
+   * ``AAVE`` is the default so existing callers (which never send a ``protocol``
+   * field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the
+   * Euler V2 path, where the market is identified by EVK vault address(es).
+   */
+  protocol?: CreditProtocol | undefined;
+  /**
+   * Euler only: the EVK collateral vault to supply into. Required when protocol=EULER and supplying collateral.
+   */
+  collateralVault?: string | null | undefined;
+  /**
+   * Euler only: the EVK vault to borrow from. Required when protocol=EULER.
+   */
+  borrowVault?: string | null | undefined;
   /**
    * Token currently held in the Credit Account to use as input. If the same as collateral_token, no swap is performed. Omit together with amount_in and collateral_token to borrow against existing collateral.
    */
@@ -151,6 +173,9 @@ export function creditBorrowRequestSlippageToJSON(
 export type CreditBorrowRequest$Outbound = {
   owner: string;
   chain: string;
+  protocol?: string | undefined;
+  collateral_vault?: string | null | undefined;
+  borrow_vault?: string | null | undefined;
   token_in?: string | null | undefined;
   amount_in?: number | string | null | undefined;
   collateral_token?: string | null | undefined;
@@ -173,6 +198,9 @@ export const CreditBorrowRequest$outboundSchema: z.ZodType<
 > = z.object({
   owner: z.string(),
   chain: Chain$outboundSchema,
+  protocol: CreditProtocol$outboundSchema.optional(),
+  collateralVault: z.nullable(z.string()).optional(),
+  borrowVault: z.nullable(z.string()).optional(),
   tokenIn: z.nullable(z.string()).optional(),
   amountIn: z.nullable(z.union([z.number(), z.string()])).optional(),
   collateralToken: z.nullable(z.string()).optional(),
@@ -187,6 +215,8 @@ export const CreditBorrowRequest$outboundSchema: z.ZodType<
   permit2Deadline: z.nullable(z.number().int()).optional(),
 }).transform((v) => {
   return remap$(v, {
+    collateralVault: "collateral_vault",
+    borrowVault: "borrow_vault",
     tokenIn: "token_in",
     amountIn: "amount_in",
     collateralToken: "collateral_token",

package/src/models/components/creditenablecollateralparams.ts

@@ -4,6 +4,10 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  CreditProtocol,
+  CreditProtocol$outboundSchema,
+} from "./creditprotocol.js";
 
 /**
  * Enable a reserve asset as collateral in Aave via Credit Account.
@@ -19,12 +23,28 @@ export type CreditEnableCollateralParams = {
    * The underlying reserve token to enable as collateral (e.g. USDC, not aUSDC).
    */
   token: string;
+  /**
+   * Which lending protocol a credit action targets.
+   *
+   * @remarks
+   *
+   * ``AAVE`` is the default so existing callers (which never send a ``protocol``
+   * field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the
+   * Euler V2 path, where the market is identified by EVK vault address(es).
+   */
+  protocol?: CreditProtocol | undefined;
+  /**
+   * Euler only: the EVK collateral vault to enable. Required when protocol=EULER.
+   */
+  collateralVault?: string | null | undefined;
 };
 
 /** @internal */
 export type CreditEnableCollateralParams$Outbound = {
   action_type: "CREDIT_ENABLE_COLLATERAL";
   token: string;
+  protocol?: string | undefined;
+  collateral_vault?: string | null | undefined;
 };
 
 /** @internal */
@@ -35,9 +55,12 @@ export const CreditEnableCollateralParams$outboundSchema: z.ZodType<
 > = z.object({
   actionType: z.literal("CREDIT_ENABLE_COLLATERAL"),
   token: z.string(),
+  protocol: CreditProtocol$outboundSchema.optional(),
+  collateralVault: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     actionType: "action_type",
+    collateralVault: "collateral_vault",
   });
 });
 

package/src/models/components/creditpositionsresponse.ts

@@ -34,9 +34,19 @@ export type CreditPositionsResponse = {
    */
   debtPositions?: Array<DebtPosition> | undefined;
   /**
-   * Aave account-level summary from getUserAccountData().
+   * Account-level summary for one lending protocol.
+   *
+   * @remarks
+   *
+   * Populated from Aave ``getUserAccountData()`` or, for Euler, from the
+   * controller vault's risk engine (``accountLiquidity``). The E-Mode fields are
+   * Aave-only and stay at their defaults for Euler.
    */
   accountSummary: AccountSummary;
+  /**
+   * Euler account-level summary (health factor, LTV, etc.), present only when the account holds Euler positions. Null for Aave-only accounts.
+   */
+  eulerAccountSummary?: AccountSummary | null | undefined;
   /**
    * All tokens available for borrowing with max amounts based on current collateral.
    */
@@ -56,6 +66,7 @@ export const CreditPositionsResponse$inboundSchema: z.ZodType<
   collateral_positions: z.array(CollateralPosition$inboundSchema).optional(),
   debt_positions: z.array(DebtPosition$inboundSchema).optional(),
   account_summary: AccountSummary$inboundSchema,
+  euler_account_summary: z.nullable(AccountSummary$inboundSchema).optional(),
   borrowable_tokens: z.array(BorrowableToken$inboundSchema).optional(),
   total_usd_value: z.nullable(z.string()).optional(),
 }).transform((v) => {
@@ -63,6 +74,7 @@ export const CreditPositionsResponse$inboundSchema: z.ZodType<
     "collateral_positions": "collateralPositions",
     "debt_positions": "debtPositions",
     "account_summary": "accountSummary",
+    "euler_account_summary": "eulerAccountSummary",
     "borrowable_tokens": "borrowableTokens",
     "total_usd_value": "totalUsdValue",
   });

package/src/models/components/creditprotocol.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Which lending protocol a credit action targets.
+ *
+ * @remarks
+ *
+ * ``AAVE`` is the default so existing callers (which never send a ``protocol``
+ * field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the
+ * Euler V2 path, where the market is identified by EVK vault address(es).
+ */
+export const CreditProtocol = {
+  Aave: "AAVE",
+  Euler: "EULER",
+} as const;
+/**
+ * Which lending protocol a credit action targets.
+ *
+ * @remarks
+ *
+ * ``AAVE`` is the default so existing callers (which never send a ``protocol``
+ * field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the
+ * Euler V2 path, where the market is identified by EVK vault address(es).
+ */
+export type CreditProtocol = ClosedEnum<typeof CreditProtocol>;
+
+/** @internal */
+export const CreditProtocol$inboundSchema: z.ZodNativeEnum<
+  typeof CreditProtocol
+> = z.nativeEnum(CreditProtocol);
+/** @internal */
+export const CreditProtocol$outboundSchema: z.ZodNativeEnum<
+  typeof CreditProtocol
+> = CreditProtocol$inboundSchema;