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

package/src/models/components/creditrepayparams.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";
 import {
   InterestRateMode,
   InterestRateMode$outboundSchema,
@@ -20,7 +24,7 @@ export type CreditRepayParamsAmount = number | string;
 export type CreditRepayParams = {
   actionType: "CREDIT_REPAY";
   /**
-   * Token to repay to Aave.
+   * Token to repay.
    */
   token: string;
   /**
@@ -35,6 +39,20 @@ export type CreditRepayParams = {
    * A stable (but typically higher rate), or a variable rate.
    */
   interestRateMode?: InterestRateMode | 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 the debt is owed to. Required when protocol=EULER.
+   */
+  borrowVault?: string | null | undefined;
 };
 
 /** @internal */
@@ -61,6 +79,8 @@ export type CreditRepayParams$Outbound = {
   token: string;
   amount: number | string;
   interest_rate_mode?: string | undefined;
+  protocol?: string | undefined;
+  borrow_vault?: string | null | undefined;
 };
 
 /** @internal */
@@ -73,10 +93,13 @@ export const CreditRepayParams$outboundSchema: z.ZodType<
   token: z.string(),
   amount: z.union([z.number(), z.string()]),
   interestRateMode: InterestRateMode$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/creditrepayrequest.ts

@@ -5,6 +5,10 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { Chain, Chain$outboundSchema } from "./chain.js";
+import {
+  CreditProtocol,
+  CreditProtocol$outboundSchema,
+} from "./creditprotocol.js";
 import {
   InterestRateMode,
   InterestRateMode$outboundSchema,
@@ -34,6 +38,24 @@ export type CreditRepayRequest = {
    * 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 vault the debt is owed to (repay target). Required when protocol=EULER.
+   */
+  borrowVault?: string | null | undefined;
+  /**
+   * Euler only: the EVK collateral vault to withdraw from. Required when protocol=EULER and withdrawing collateral.
+   */
+  collateralVault?: string | null | undefined;
   /**
    * The borrowed asset to repay (e.g. WETH). Must match the debt position's token.
    */
@@ -134,6 +156,9 @@ export function creditRepayRequestSlippageToJSON(
 export type CreditRepayRequest$Outbound = {
   owner: string;
   chain: string;
+  protocol?: string | undefined;
+  borrow_vault?: string | null | undefined;
+  collateral_vault?: string | null | undefined;
   repay_token: string;
   repay_amount: number | string;
   interest_rate_mode?: string | undefined;
@@ -155,6 +180,9 @@ export const CreditRepayRequest$outboundSchema: z.ZodType<
 > = z.object({
   owner: z.string(),
   chain: Chain$outboundSchema,
+  protocol: CreditProtocol$outboundSchema.optional(),
+  borrowVault: z.nullable(z.string()).optional(),
+  collateralVault: z.nullable(z.string()).optional(),
   repayToken: z.string(),
   repayAmount: z.union([z.number(), z.string()]),
   interestRateMode: InterestRateMode$outboundSchema.optional(),
@@ -168,6 +196,8 @@ export const CreditRepayRequest$outboundSchema: z.ZodType<
   permit2Deadline: z.nullable(z.number().int()).optional(),
 }).transform((v) => {
   return remap$(v, {
+    borrowVault: "borrow_vault",
+    collateralVault: "collateral_vault",
     repayToken: "repay_token",
     repayAmount: "repay_amount",
     interestRateMode: "interest_rate_mode",

package/src/models/components/creditsupplyparams.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";
 
 /**
  * Amount in token units to supply.
@@ -16,13 +20,27 @@ export type CreditSupplyParamsAmount = number | string;
 export type CreditSupplyParams = {
   actionType: "CREDIT_SUPPLY";
   /**
-   * Collateral token to supply to Aave.
+   * Collateral token to supply.
    */
   token: string;
   /**
    * Amount in token units to supply.
    */
   amount: number | 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 supply into. Required when protocol=EULER.
+   */
+  collateralVault?: string | null | undefined;
 };
 
 /** @internal */
@@ -48,6 +66,8 @@ export type CreditSupplyParams$Outbound = {
   action_type: "CREDIT_SUPPLY";
   token: string;
   amount: number | string;
+  protocol?: string | undefined;
+  collateral_vault?: string | null | undefined;
 };
 
 /** @internal */
@@ -59,9 +79,12 @@ export const CreditSupplyParams$outboundSchema: z.ZodType<
   actionType: z.literal("CREDIT_SUPPLY"),
   token: z.string(),
   amount: z.union([z.number(), 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/creditwithdrawparams.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";
 
 /**
  * Amount in token units to withdraw.
@@ -16,13 +20,27 @@ export type CreditWithdrawParamsAmount = number | string;
 export type CreditWithdrawParams = {
   actionType: "CREDIT_WITHDRAW";
   /**
-   * Collateral token to withdraw from Aave.
+   * Collateral token to withdraw.
    */
   token: string;
   /**
    * Amount in token units to withdraw.
    */
   amount: number | 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 withdraw from. Required when protocol=EULER.
+   */
+  collateralVault?: string | null | undefined;
 };
 
 /** @internal */
@@ -48,6 +66,8 @@ export type CreditWithdrawParams$Outbound = {
   action_type: "CREDIT_WITHDRAW";
   token: string;
   amount: number | string;
+  protocol?: string | undefined;
+  collateral_vault?: string | null | undefined;
 };
 
 /** @internal */
@@ -59,9 +79,12 @@ export const CreditWithdrawParams$outboundSchema: z.ZodType<
   actionType: z.literal("CREDIT_WITHDRAW"),
   token: z.string(),
   amount: z.union([z.number(), 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/debtposition.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 debt position.
@@ -22,7 +26,21 @@ export type DebtPosition = {
    */
   symbol: string;
   /**
-   * Current on-chain variable debt balance.
+   * 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 borrow vault this debt is owed to.
+   */
+  vault?: string | null | undefined;
+  /**
+   * Current on-chain debt balance (the vault's underlying asset for Euler).
    */
   amountBorrowed: string | null;
   /**
@@ -59,6 +77,8 @@ export const DebtPosition$inboundSchema: z.ZodType<
 > = z.object({
   token: z.string(),
   symbol: z.string(),
+  protocol: CreditProtocol$inboundSchema.optional(),
+  vault: z.nullable(z.string()).optional(),
   amount_borrowed: z.nullable(z.string()),
   usd_value: z.nullable(z.string()).optional(),
   borrow_apy: z.nullable(z.string()).optional(),

package/src/models/components/index.ts

@@ -103,6 +103,7 @@ export * from "./creditenablecollateralparams.js";
 export * from "./creditevent.js";
 export * from "./creditfee.js";
 export * from "./creditpositionsresponse.js";
+export * from "./creditprotocol.js";
 export * from "./creditrepayparams.js";
 export * from "./creditrepayrequest.js";
 export * from "./creditrepayresponse.js";