@compass-labs/api-sdk 2.2.29 → 2.2.30

package/src/models/components/earntransferresponse.ts

@@ -20,13 +20,26 @@ import {
   UnsignedTransaction$inboundSchema,
 } from "./unsignedtransaction.js";
 
+/**
+ * EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true.
+ */
 export type EarnTransferResponseEip712 =
   | BatchedSafeOperationsResponseOutput
   | Permit2TypedDataOutput;
 
 export type EarnTransferResponse = {
-  transaction: UnsignedTransaction | null;
-  eip712: BatchedSafeOperationsResponseOutput | Permit2TypedDataOutput | null;
+  /**
+   * Unsigned transaction for direct execution. Present when gas_sponsorship=false.
+   */
+  transaction?: UnsignedTransaction | null | undefined;
+  /**
+   * EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true.
+   */
+  eip712?:
+    | BatchedSafeOperationsResponseOutput
+    | Permit2TypedDataOutput
+    | null
+    | undefined;
 };
 
 /** @internal */
@@ -55,13 +68,13 @@ export const EarnTransferResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  transaction: z.nullable(UnsignedTransaction$inboundSchema),
+  transaction: z.nullable(UnsignedTransaction$inboundSchema).optional(),
   eip_712: z.nullable(
     z.union([
       BatchedSafeOperationsResponseOutput$inboundSchema,
       Permit2TypedDataOutput$inboundSchema,
     ]),
-  ),
+  ).optional(),
 }).transform((v) => {
   return remap$(v, {
     "eip_712": "eip712",

package/src/models/components/index.ts

@@ -99,6 +99,7 @@ export * from "./creditrepayresponse.js";
 export * from "./creditsupplyparams.js";
 export * from "./credittransferrequest.js";
 export * from "./credittransferresponse.js";
+export * from "./credittransfertoaddressparams.js";
 export * from "./credituseroperation.js";
 export * from "./creditwithdrawparams.js";
 export * from "./debtposition.js";

package/src/models/components/marketallocation.ts

@@ -13,39 +13,39 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export type MarketAllocation = {
   /**
-   * Morpho Blue market ID (bytes32 hex)
+   * Morpho Blue market unique identifier (bytes32 hex string).
    */
   marketId: string;
   /**
-   * Loan token address
+   * Address of the token being lent in this market.
    */
   loanToken: string;
   /**
-   * Loan token symbol
+   * Symbol of the loan token (e.g., 'USDC').
    */
   loanTokenSymbol?: string | null | undefined;
   /**
-   * Collateral token address
+   * Address of the collateral token accepted by this market.
    */
   collateralToken: string;
   /**
-   * Collateral token symbol
+   * Symbol of the collateral token (e.g., 'WETH').
    */
   collateralTokenSymbol?: string | null | undefined;
   /**
-   * Liquidation LTV (raw uint256 as string)
+   * Liquidation Loan-To-Value ratio as a raw uint256 string. Divide by 1e18 to get the decimal ratio (e.g., '860000000000000000' = 86%).
    */
   lltv: string;
   /**
-   * Max supply cap (raw uint184 as string)
+   * Maximum amount the vault is allowed to supply to this market, as a raw uint184 string in the smallest token unit.
    */
   supplyCap?: string | null | undefined;
   /**
-   * Current supply amount in asset units (converted from shares)
+   * Amount currently supplied by the vault to this market, in the smallest token unit (converted from shares).
    */
   supplyAssets?: string | null | undefined;
   /**
-   * Percentage of vault's total supply allocated to this market
+   * Percentage of the vault's total supplied capital allocated to this market (e.g., 45.5 means 45.5%).
    */
   allocationPct?: number | null | undefined;
 };

package/src/models/components/vaultinfo.ts

@@ -49,13 +49,21 @@ export type VaultInfo = {
    */
   assetSymbol?: string | null | undefined;
   /**
-   * Total Value Locked in USD.
+   * Total Value Locked in USD. Represents the total assets deposited in the vault.
    */
   tvlUsd?: string | null | undefined;
   /**
-   * Available liquidity in USD (withdrawable amount).
+   * Available liquidity in USD. The amount that can be withdrawn right now, accounting for idle funds and borrowable supply across the vault's markets. Always <= tvl_usd.
    */
   liquidityUsd?: string | null | undefined;
+  /**
+   * Maximum additional amount that can be deposited into the vault, in human-readable token units (e.g., 1000.5 USDC). Derived from the ERC4626 maxDeposit function. A value of 0 means the vault is paused or full.
+   */
+  depositCap?: string | null | undefined;
+  /**
+   * Maximum additional depositable amount converted to USD.
+   */
+  depositCapUsd?: string | null | undefined;
   /**
    * 7-day APY as a percentage (e.g., 5.25 = 5.25%).
    */
@@ -69,7 +77,7 @@ export type VaultInfo = {
    */
   apy90d?: string | null | undefined;
   /**
-   * Morpho Blue markets in this vault's supply queue
+   * Morpho Blue markets in this vault's supply queue, ordered by queue index. Shows how the vault's capital is split across lending markets with different collateral types and risk parameters.
    */
   markets?: Array<MarketAllocation> | undefined;
 };
@@ -90,6 +98,8 @@ export const VaultInfo$inboundSchema: z.ZodType<
   asset_symbol: z.nullable(z.string()).optional(),
   tvl_usd: z.nullable(z.string()).optional(),
   liquidity_usd: z.nullable(z.string()).optional(),
+  deposit_cap: z.nullable(z.string()).optional(),
+  deposit_cap_usd: z.nullable(z.string()).optional(),
   apy_7d: z.nullable(z.string()).optional(),
   apy_30d: z.nullable(z.string()).optional(),
   apy_90d: z.nullable(z.string()).optional(),
@@ -101,6 +111,8 @@ export const VaultInfo$inboundSchema: z.ZodType<
     "asset_symbol": "assetSymbol",
     "tvl_usd": "tvlUsd",
     "liquidity_usd": "liquidityUsd",
+    "deposit_cap": "depositCap",
+    "deposit_cap_usd": "depositCapUsd",
     "apy_7d": "apy7d",
     "apy_30d": "apy30d",
     "apy_90d": "apy90d",

package/src/models/operations/v2earnvaults.ts

@@ -29,6 +29,11 @@ export type V2EarnVaultsMinTvlUsd = number | string;
  */
 export type MinLiquidityUsd = number | string;
 
+/**
+ * Minimum deposit capacity in USD. Vaults below this are excluded. Set to 0 to exclude paused vaults.
+ */
+export type MinDepositCapUsd = number | string;
+
 export type V2EarnVaultsRequest = {
   /**
    * The field to order the results by.
@@ -62,6 +67,10 @@ export type V2EarnVaultsRequest = {
    * Minimum available liquidity in USD. Vaults below this are excluded.
    */
   minLiquidityUsd?: number | string | null | undefined;
+  /**
+   * Minimum deposit capacity in USD. Vaults below this are excluded. Set to 0 to exclude paused vaults.
+   */
+  minDepositCapUsd?: number | string | null | undefined;
 };
 
 /** @internal */
@@ -103,6 +112,24 @@ export function minLiquidityUsdToJSON(
   return JSON.stringify(MinLiquidityUsd$outboundSchema.parse(minLiquidityUsd));
 }
 
+/** @internal */
+export type MinDepositCapUsd$Outbound = number | string;
+
+/** @internal */
+export const MinDepositCapUsd$outboundSchema: z.ZodType<
+  MinDepositCapUsd$Outbound,
+  z.ZodTypeDef,
+  MinDepositCapUsd
+> = z.union([z.number(), z.string()]);
+
+export function minDepositCapUsdToJSON(
+  minDepositCapUsd: MinDepositCapUsd,
+): string {
+  return JSON.stringify(
+    MinDepositCapUsd$outboundSchema.parse(minDepositCapUsd),
+  );
+}
+
 /** @internal */
 export type V2EarnVaultsRequest$Outbound = {
   order_by: string;
@@ -113,6 +140,7 @@ export type V2EarnVaultsRequest$Outbound = {
   asset_symbol?: string | null | undefined;
   min_tvl_usd?: number | string | null | undefined;
   min_liquidity_usd?: number | string | null | undefined;
+  min_deposit_cap_usd?: number | string | null | undefined;
 };
 
 /** @internal */
@@ -129,12 +157,14 @@ export const V2EarnVaultsRequest$outboundSchema: z.ZodType<
   assetSymbol: z.nullable(z.string()).optional(),
   minTvlUsd: z.nullable(z.union([z.number(), z.string()])).optional(),
   minLiquidityUsd: z.nullable(z.union([z.number(), z.string()])).optional(),
+  minDepositCapUsd: z.nullable(z.union([z.number(), z.string()])).optional(),
 }).transform((v) => {
   return remap$(v, {
     orderBy: "order_by",
     assetSymbol: "asset_symbol",
     minTvlUsd: "min_tvl_usd",
     minLiquidityUsd: "min_liquidity_usd",
+    minDepositCapUsd: "min_deposit_cap_usd",
   });
 });
 

package/src/sdk/credit.ts

@@ -136,7 +136,7 @@ export class Credit extends ClientSDK {
   }
 
   /**
-   * Execute multiple credit actions atomically
+   * Execute multiple credit actions
    *
    * @remarks
    * Compose individual credit operations (supply, withdraw, borrow, repay, swap, transfer)