@compass-labs/api-sdk 2.2.77-rc.0 → 2.2.77

package/src/funcs/creditCreditLoopedPositions.ts

@@ -0,0 +1,185 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { CompassAPISDKError } from "../models/errors/compassapisdkerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List looped (leveraged) credit positions
+ *
+ * @remarks
+ * List looped (leveraged) positions for a credit account owner.
+ *
+ * Detects loops from the account's on-chain history: a transaction containing
+ * lending + borrowing + swap legs is a loop transaction. Returns one position
+ * per Morpho market / Aave collateral+debt reserve pair, each with its complete
+ * per-transaction history, lifetime totals, and live on-chain state (health
+ * factor, USD values, leverage) for open positions. Covers Aave V3 and Morpho
+ * Blue.
+ */
+export function creditCreditLoopedPositions(
+  client: CompassApiSDKCore,
+  request: operations.V2CreditLoopedPositionsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.CreditLoopedPositionsResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: operations.V2CreditLoopedPositionsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.CreditLoopedPositionsResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.V2CreditLoopedPositionsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v2/credit/looped_positions")();
+
+  const query = encodeFormQuery({
+    "chain": payload.chain,
+    "owner": payload.owner,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "v2_credit_looped_positions",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.CreditLoopedPositionsResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.CreditLoopedPositionsResponse$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/models/components/creditloopedpositionsresponse.ts

@@ -0,0 +1,61 @@
+/*
+ * 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";
+import {
+  AccountSummary,
+  AccountSummary$inboundSchema,
+} from "./accountsummary.js";
+import {
+  LoopedPosition,
+  LoopedPosition$inboundSchema,
+} from "./loopedposition.js";
+
+/**
+ * Looped positions across Aave V3 and Morpho Blue for a credit account.
+ */
+export type CreditLoopedPositionsResponse = {
+  /**
+   * The credit product account address derived from the owner.
+   */
+  creditAccountAddress: string;
+  /**
+   * All looped positions, on both Aave and Morpho.
+   */
+  positions?: Array<LoopedPosition> | undefined;
+  /**
+   * Aave account-level summary (health factor, LTV, borrow capacity). Present when the account holds any open Aave looped position, since Aave collateral is pooled and health is account-level. Null for Morpho-only accounts.
+   */
+  aaveAccountSummary?: AccountSummary | null | undefined;
+};
+
+/** @internal */
+export const CreditLoopedPositionsResponse$inboundSchema: z.ZodType<
+  CreditLoopedPositionsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  credit_account_address: z.string(),
+  positions: z.array(LoopedPosition$inboundSchema).optional(),
+  aave_account_summary: z.nullable(AccountSummary$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "credit_account_address": "creditAccountAddress",
+    "aave_account_summary": "aaveAccountSummary",
+  });
+});
+
+export function creditLoopedPositionsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreditLoopedPositionsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreditLoopedPositionsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreditLoopedPositionsResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -102,6 +102,7 @@ export * from "./creditbundleresponse.js";
 export * from "./creditenablecollateralparams.js";
 export * from "./creditevent.js";
 export * from "./creditfee.js";
+export * from "./creditloopedpositionsresponse.js";
 export * from "./creditlooppreview.js";
 export * from "./creditlooprequest.js";
 export * from "./creditloopresponse.js";
@@ -185,6 +186,10 @@ export * from "./globalmarketsperpswithdrawrequest.js";
 export * from "./interestratemode.js";
 export * from "./liquidationcall.js";
 export * from "./listaavemarketsresponse.js";
+export * from "./loopedposition.js";
+export * from "./loopedpositioncurrentstate.js";
+export * from "./loopedpositionhistoryentry.js";
+export * from "./loopedpositiontotals.js";
 export * from "./looplegpreview.js";
 export * from "./lpbalance.js";
 export * from "./marketallocation.js";
@@ -299,6 +304,7 @@ export * from "./sponsorgasresponse.js";
 export * from "./supply.js";
 export * from "./supportedchaininfo.js";
 export * from "./swapborrowrate.js";
+export * from "./swapinfo.js";
 export * from "./syposition.js";
 export * from "./tokenamount.js";
 export * from "./tokenbalanceresponse.js";

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`,
+  );
+}