@compass-labs/api-sdk 2.2.76 → 2.2.77-rc.1

package/src/models/components/loopedposition.ts

@@ -0,0 +1,149 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 {
+  CreditProtocol,
+  CreditProtocol$inboundSchema,
+} from "./creditprotocol.js";
+import {
+  LoopedPositionCurrentState,
+  LoopedPositionCurrentState$inboundSchema,
+} from "./loopedpositioncurrentstate.js";
+import {
+  LoopedPositionHistoryEntry,
+  LoopedPositionHistoryEntry$inboundSchema,
+} from "./loopedpositionhistoryentry.js";
+import {
+  LoopedPositionTotals,
+  LoopedPositionTotals$inboundSchema,
+} from "./loopedpositiontotals.js";
+
+/**
+ * Whether the position is currently open or fully closed.
+ */
+export const LoopedPositionStatus = {
+  Open: "OPEN",
+  Closed: "CLOSED",
+} as const;
+/**
+ * Whether the position is currently open or fully closed.
+ */
+export type LoopedPositionStatus = ClosedEnum<typeof LoopedPositionStatus>;
+
+/**
+ * A single looped (leveraged) position with its full history.
+ */
+export type LoopedPosition = {
+  /**
+   * 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).
+   * ``MORPHO`` identifies Morpho Blue lending markets (bytes32 market id) and is
+   * currently read-only: positions and market discovery only — transaction
+   * builders land with the looping work (COM-7106/7107/7108), so transact
+   * endpoints reject it with a 422.
+   */
+  protocol: CreditProtocol;
+  /**
+   * Morpho only: the bytes32 id of the isolated market.
+   */
+  marketId?: string | null | undefined;
+  /**
+   * Address of the collateral token.
+   */
+  collateralToken: string;
+  /**
+   * Symbol of the collateral token.
+   */
+  collateralSymbol: string;
+  /**
+   * Address of the debt token.
+   */
+  debtToken: string;
+  /**
+   * Symbol of the debt token.
+   */
+  debtSymbol: string;
+  /**
+   * Whether the position is currently open or fully closed.
+   */
+  status: LoopedPositionStatus;
+  /**
+   * Timestamp of the position's first transaction.
+   */
+  openedAt: Date;
+  /**
+   * Timestamp the position was fully closed; null while open.
+   */
+  closedAt?: Date | null | undefined;
+  /**
+   * Live on-chain state; null for CLOSED positions.
+   */
+  current?: LoopedPositionCurrentState | null | undefined;
+  /**
+   * Lifetime totals across all of a looped position's transactions.
+   */
+  totals: LoopedPositionTotals;
+  /**
+   * All transactions for this position, chronological.
+   */
+  history?: Array<LoopedPositionHistoryEntry> | undefined;
+};
+
+/** @internal */
+export const LoopedPositionStatus$inboundSchema: z.ZodNativeEnum<
+  typeof LoopedPositionStatus
+> = z.nativeEnum(LoopedPositionStatus);
+
+/** @internal */
+export const LoopedPosition$inboundSchema: z.ZodType<
+  LoopedPosition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  protocol: CreditProtocol$inboundSchema,
+  market_id: z.nullable(z.string()).optional(),
+  collateral_token: z.string(),
+  collateral_symbol: z.string(),
+  debt_token: z.string(),
+  debt_symbol: z.string(),
+  status: LoopedPositionStatus$inboundSchema,
+  opened_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  closed_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  current: z.nullable(LoopedPositionCurrentState$inboundSchema).optional(),
+  totals: LoopedPositionTotals$inboundSchema,
+  history: z.array(LoopedPositionHistoryEntry$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "market_id": "marketId",
+    "collateral_token": "collateralToken",
+    "collateral_symbol": "collateralSymbol",
+    "debt_token": "debtToken",
+    "debt_symbol": "debtSymbol",
+    "opened_at": "openedAt",
+    "closed_at": "closedAt",
+  });
+});
+
+export function loopedPositionFromJSON(
+  jsonString: string,
+): SafeParseResult<LoopedPosition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LoopedPosition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LoopedPosition' from JSON`,
+  );
+}

package/src/models/components/loopedpositioncurrentstate.ts

@@ -0,0 +1,101 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+
+/**
+ * 'market' for Morpho (isolated per-market health). 'account' for Aave: collateral is pooled, so all collateral backs all debt and this health factor is shared by every Aave position on the account — see aave_account_summary for the account-level figures.
+ */
+export const HealthFactorScope = {
+  Market: "market",
+  Account: "account",
+} as const;
+/**
+ * 'market' for Morpho (isolated per-market health). 'account' for Aave: collateral is pooled, so all collateral backs all debt and this health factor is shared by every Aave position on the account — see aave_account_summary for the account-level figures.
+ */
+export type HealthFactorScope = ClosedEnum<typeof HealthFactorScope>;
+
+/**
+ * Live on-chain state of an OPEN looped position.
+ */
+export type LoopedPositionCurrentState = {
+  /**
+   * Current on-chain collateral amount for this position.
+   */
+  collateralAmount: string | null;
+  /**
+   * Current on-chain debt amount for this position.
+   */
+  debtAmount: string | null;
+  /**
+   * Collateral value in USD (null if unpriced).
+   */
+  collateralUsd?: string | null | undefined;
+  /**
+   * Debt value in USD (null if unpriced).
+   */
+  debtUsd?: string | null | undefined;
+  /**
+   * Net position value in USD (collateral - debt); null if unpriced.
+   */
+  netUsdValue?: string | null | undefined;
+  /**
+   * Leverage multiplier: collateral_usd / (collateral_usd - debt_usd). Null when unpriced or net value is non-positive.
+   */
+  leverage?: string | null | undefined;
+  /**
+   * Health factor. Above 1 is safe; below 1 risks liquidation. See health_factor_scope for what it covers.
+   */
+  healthFactor?: string | null | undefined;
+  /**
+   * 'market' for Morpho (isolated per-market health). 'account' for Aave: collateral is pooled, so all collateral backs all debt and this health factor is shared by every Aave position on the account — see aave_account_summary for the account-level figures.
+   */
+  healthFactorScope: HealthFactorScope;
+};
+
+/** @internal */
+export const HealthFactorScope$inboundSchema: z.ZodNativeEnum<
+  typeof HealthFactorScope
+> = z.nativeEnum(HealthFactorScope);
+
+/** @internal */
+export const LoopedPositionCurrentState$inboundSchema: z.ZodType<
+  LoopedPositionCurrentState,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  collateral_amount: z.nullable(z.string()),
+  debt_amount: z.nullable(z.string()),
+  collateral_usd: z.nullable(z.string()).optional(),
+  debt_usd: z.nullable(z.string()).optional(),
+  net_usd_value: z.nullable(z.string()).optional(),
+  leverage: z.nullable(z.string()).optional(),
+  health_factor: z.nullable(z.string()).optional(),
+  health_factor_scope: HealthFactorScope$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "collateral_amount": "collateralAmount",
+    "debt_amount": "debtAmount",
+    "collateral_usd": "collateralUsd",
+    "debt_usd": "debtUsd",
+    "net_usd_value": "netUsdValue",
+    "health_factor": "healthFactor",
+    "health_factor_scope": "healthFactorScope",
+  });
+});
+
+export function loopedPositionCurrentStateFromJSON(
+  jsonString: string,
+): SafeParseResult<LoopedPositionCurrentState, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LoopedPositionCurrentState$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LoopedPositionCurrentState' from JSON`,
+  );
+}

package/src/models/components/loopedpositionhistoryentry.ts

@@ -0,0 +1,115 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 { CreditEvent, CreditEvent$inboundSchema } from "./creditevent.js";
+import { SwapInfo, SwapInfo$inboundSchema } from "./swapinfo.js";
+
+/**
+ * What this transaction did to the position: loop_open / loop_increase (lever up with a swap), unwind (delever), single-sided supply/withdraw/borrow/repay, liquidation, or mixed.
+ */
+export const Classification = {
+  LoopOpen: "loop_open",
+  LoopIncrease: "loop_increase",
+  Unwind: "unwind",
+  Supply: "supply",
+  Withdraw: "withdraw",
+  Borrow: "borrow",
+  Repay: "repay",
+  Liquidation: "liquidation",
+  Mixed: "mixed",
+} as const;
+/**
+ * What this transaction did to the position: loop_open / loop_increase (lever up with a swap), unwind (delever), single-sided supply/withdraw/borrow/repay, liquidation, or mixed.
+ */
+export type Classification = ClosedEnum<typeof Classification>;
+
+/**
+ * One transaction in a looped position's lifetime.
+ */
+export type LoopedPositionHistoryEntry = {
+  /**
+   * Transaction hash.
+   */
+  transactionHash: string;
+  /**
+   * Block number of the transaction.
+   */
+  blockNumber: number;
+  /**
+   * Timestamp of the transaction.
+   */
+  blockTimestamp: Date;
+  /**
+   * What this transaction did to the position: loop_open / loop_increase (lever up with a swap), unwind (delever), single-sided supply/withdraw/borrow/repay, liquidation, or mixed.
+   */
+  classification: Classification;
+  /**
+   * Loop transactions only: number of borrow legs in this transaction (one per loop iteration). Null for non-loop transactions.
+   */
+  iterations?: number | null | undefined;
+  /**
+   * Signed change in collateral in this transaction (positive = added).
+   */
+  collateralDelta: string;
+  /**
+   * Signed change in debt in this transaction (positive = borrowed).
+   */
+  debtDelta: string;
+  /**
+   * The swap leg detected in this transaction, if any.
+   */
+  swap?: SwapInfo | null | undefined;
+  /**
+   * The raw lending events that make up this transaction (Morpho supply_collateral maps to 'supply', withdraw_collateral to 'withdraw').
+   */
+  events?: Array<CreditEvent> | undefined;
+};
+
+/** @internal */
+export const Classification$inboundSchema: z.ZodNativeEnum<
+  typeof Classification
+> = z.nativeEnum(Classification);
+
+/** @internal */
+export const LoopedPositionHistoryEntry$inboundSchema: z.ZodType<
+  LoopedPositionHistoryEntry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transaction_hash: z.string(),
+  block_number: z.number().int(),
+  block_timestamp: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  classification: Classification$inboundSchema,
+  iterations: z.nullable(z.number().int()).optional(),
+  collateral_delta: z.string(),
+  debt_delta: z.string(),
+  swap: z.nullable(SwapInfo$inboundSchema).optional(),
+  events: z.array(CreditEvent$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "transaction_hash": "transactionHash",
+    "block_number": "blockNumber",
+    "block_timestamp": "blockTimestamp",
+    "collateral_delta": "collateralDelta",
+    "debt_delta": "debtDelta",
+  });
+});
+
+export function loopedPositionHistoryEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<LoopedPositionHistoryEntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LoopedPositionHistoryEntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LoopedPositionHistoryEntry' from JSON`,
+  );
+}

package/src/models/components/loopedpositiontotals.ts

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * Lifetime totals across all of a looped position's transactions.
+ */
+export type LoopedPositionTotals = {
+  /**
+   * Total collateral added over the position's lifetime.
+   */
+  totalCollateralAdded: string;
+  /**
+   * Total collateral removed over the position's lifetime.
+   */
+  totalCollateralRemoved: string;
+  /**
+   * Total debt borrowed over the position's lifetime.
+   */
+  totalDebtAdded: string;
+  /**
+   * Total debt repaid over the position's lifetime.
+   */
+  totalDebtRemoved: string;
+  /**
+   * Number of loop_open + loop_increase transactions.
+   */
+  loopTxCount: number;
+  /**
+   * Number of unwind transactions.
+   */
+  unwindTxCount: number;
+  /**
+   * Number of liquidation events.
+   */
+  liquidationCount: number;
+};
+
+/** @internal */
+export const LoopedPositionTotals$inboundSchema: z.ZodType<
+  LoopedPositionTotals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total_collateral_added: z.string(),
+  total_collateral_removed: z.string(),
+  total_debt_added: z.string(),
+  total_debt_removed: z.string(),
+  loop_tx_count: z.number().int(),
+  unwind_tx_count: z.number().int(),
+  liquidation_count: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_collateral_added": "totalCollateralAdded",
+    "total_collateral_removed": "totalCollateralRemoved",
+    "total_debt_added": "totalDebtAdded",
+    "total_debt_removed": "totalDebtRemoved",
+    "loop_tx_count": "loopTxCount",
+    "unwind_tx_count": "unwindTxCount",
+    "liquidation_count": "liquidationCount",
+  });
+});
+
+export function loopedPositionTotalsFromJSON(
+  jsonString: string,
+): SafeParseResult<LoopedPositionTotals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LoopedPositionTotals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LoopedPositionTotals' from JSON`,
+  );
+}

package/src/models/components/looplegpreview.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * One planned loop iteration.
+ */
+export type LoopLegPreview = {
+  /**
+   * Collateral supplied this iteration (token units).
+   */
+  supplyAmount: string | null;
+  /**
+   * Loan borrowed this iteration; null on the final supply-only iteration.
+   */
+  borrowAmount?: string | null | undefined;
+  /**
+   * Guaranteed swap output (collateral units) — the next iteration's supply. Enforced on-chain by the swap's minimum-return.
+   */
+  minSwapOut?: string | null | undefined;
+};
+
+/** @internal */
+export const LoopLegPreview$inboundSchema: z.ZodType<
+  LoopLegPreview,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  supply_amount: z.nullable(z.string()),
+  borrow_amount: z.nullable(z.string()).optional(),
+  min_swap_out: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "supply_amount": "supplyAmount",
+    "borrow_amount": "borrowAmount",
+    "min_swap_out": "minSwapOut",
+  });
+});
+
+export function loopLegPreviewFromJSON(
+  jsonString: string,
+): SafeParseResult<LoopLegPreview, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LoopLegPreview$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LoopLegPreview' from JSON`,
+  );
+}

package/src/models/components/morpholendingmarket.ts

@@ -0,0 +1,133 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * A Morpho Blue lending market: one isolated (collateral, loan) pair.
+ */
+export type MorphoLendingMarket = {
+  /**
+   * Morpho Blue market id — the bytes32 keccak of the market's (loanToken, collateralToken, oracle, irm, lltv) tuple. Pass this to the Morpho credit actions to identify the market.
+   */
+  marketId: string;
+  /**
+   * Token that is supplied and borrowed in this market.
+   */
+  loanToken: string;
+  /**
+   * Symbol of the loan token (e.g. USDC).
+   */
+  loanTokenSymbol: string;
+  /**
+   * Decimals of the loan token.
+   */
+  loanTokenDecimals: number;
+  /**
+   * Token accepted as collateral in this market.
+   */
+  collateralToken: string;
+  /**
+   * Symbol of the collateral token (e.g. wstETH).
+   */
+  collateralTokenSymbol: string;
+  /**
+   * Decimals of the collateral token.
+   */
+  collateralTokenDecimals: number;
+  /**
+   * Oracle pricing the collateral in loan-token terms for this market.
+   */
+  oracle: string;
+  /**
+   * Interest rate model contract of this market.
+   */
+  irm: string;
+  /**
+   * Liquidation loan-to-value in percentage (e.g. 86 means a position is liquidatable once debt exceeds 86% of collateral value).
+   */
+  lltv: string;
+  /**
+   * Current supply APY for lending the loan token, in percentage (e.g. 3.5 means 3.5%). Null if the rate is unavailable.
+   */
+  supplyApy?: string | null | undefined;
+  /**
+   * Current borrow APY for the loan token, in percentage (e.g. 5.25 means 5.25%). Null if the rate is unavailable.
+   */
+  borrowApy?: string | null | undefined;
+  /**
+   * Borrowed share of supplied assets, in percentage 0-100.
+   */
+  utilization: string;
+  /**
+   * Total loan tokens supplied to the market, in token units.
+   */
+  totalSupplyAssets: string;
+  /**
+   * Total loan tokens borrowed from the market, in token units.
+   */
+  totalBorrowAssets: string;
+  /**
+   * Loan tokens available to borrow or withdraw (supplied - borrowed), in token units.
+   */
+  availableLiquidity: string;
+  /**
+   * Protocol fee taken from interest, in percentage of interest (e.g. 0 means no fee).
+   */
+  fee: string;
+};
+
+/** @internal */
+export const MorphoLendingMarket$inboundSchema: z.ZodType<
+  MorphoLendingMarket,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  market_id: z.string(),
+  loan_token: z.string(),
+  loan_token_symbol: z.string(),
+  loan_token_decimals: z.number().int(),
+  collateral_token: z.string(),
+  collateral_token_symbol: z.string(),
+  collateral_token_decimals: z.number().int(),
+  oracle: z.string(),
+  irm: z.string(),
+  lltv: z.string(),
+  supply_apy: z.nullable(z.string()).optional(),
+  borrow_apy: z.nullable(z.string()).optional(),
+  utilization: z.string(),
+  total_supply_assets: z.string(),
+  total_borrow_assets: z.string(),
+  available_liquidity: z.string(),
+  fee: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "market_id": "marketId",
+    "loan_token": "loanToken",
+    "loan_token_symbol": "loanTokenSymbol",
+    "loan_token_decimals": "loanTokenDecimals",
+    "collateral_token": "collateralToken",
+    "collateral_token_symbol": "collateralTokenSymbol",
+    "collateral_token_decimals": "collateralTokenDecimals",
+    "supply_apy": "supplyApy",
+    "borrow_apy": "borrowApy",
+    "total_supply_assets": "totalSupplyAssets",
+    "total_borrow_assets": "totalBorrowAssets",
+    "available_liquidity": "availableLiquidity",
+  });
+});
+
+export function morphoLendingMarketFromJSON(
+  jsonString: string,
+): SafeParseResult<MorphoLendingMarket, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MorphoLendingMarket$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MorphoLendingMarket' from JSON`,
+  );
+}

package/src/models/components/morphomarketsresponse.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  MorphoLendingMarket,
+  MorphoLendingMarket$inboundSchema,
+} from "./morpholendingmarket.js";
+
+/**
+ * Curated Morpho Blue lending markets, read on-chain per request.
+ */
+export type MorphoMarketsResponse = {
+  /**
+   * Morpho Blue singleton contract the markets were read from.
+   */
+  morpho: string;
+  /**
+   * Curated lending markets with live LLTV, APYs, utilization, and liquidity.
+   */
+  markets?: Array<MorphoLendingMarket> | undefined;
+};
+
+/** @internal */
+export const MorphoMarketsResponse$inboundSchema: z.ZodType<
+  MorphoMarketsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  morpho: z.string(),
+  markets: z.array(MorphoLendingMarket$inboundSchema).optional(),
+});
+
+export function morphoMarketsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<MorphoMarketsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MorphoMarketsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MorphoMarketsResponse' from JSON`,
+  );
+}