@compass-labs/api-sdk 2.2.71 → 2.2.72

package/src/funcs/creditCreditEulerMarkets.ts

@@ -0,0 +1,182 @@
+/*
+ * 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 curated Euler markets
+ *
+ * @remarks
+ * List curated Euler V2 credit markets for a chain.
+ *
+ * Euler is permissionless, so credit borrow/repay identify a market by EVK vault
+ * address. This returns the borrow markets from Euler's Governed Perspective (the
+ * DAO-vetted vault set) -- each with the collateral vaults it accepts and their
+ * LTVs -- so callers know which borrow_vault / collateral_vault to use.
+ */
+export function creditCreditEulerMarkets(
+  client: CompassApiSDKCore,
+  request: operations.V2CreditEulerMarketsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.EulerMarketsResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: operations.V2CreditEulerMarketsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.EulerMarketsResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.V2CreditEulerMarketsRequest$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/euler_markets")();
+
+  const query = encodeFormQuery({
+    "chain": payload.chain,
+  });
+
+  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_euler_markets",
+    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.EulerMarketsResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.EulerMarketsResponse$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/eulermarket.ts

@@ -0,0 +1,73 @@
+/*
+ * 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 {
+  EulerMarketCollateral,
+  EulerMarketCollateral$inboundSchema,
+} from "./eulermarketcollateral.js";
+
+/**
+ * An Euler V2 borrow market: a vault to borrow from + the collaterals it accepts.
+ */
+export type EulerMarket = {
+  /**
+   * EVK vault to borrow from (pass as borrow_vault when borrowing).
+   */
+  vault: string;
+  /**
+   * Symbol of the EVK vault (e.g. eUSDT-2).
+   */
+  vaultSymbol: string;
+  /**
+   * Underlying asset this market lends and borrows.
+   */
+  asset: string;
+  /**
+   * Symbol of the borrowable asset (e.g. USDT).
+   */
+  assetSymbol: string;
+  /**
+   * Decimals of the borrowable asset.
+   */
+  assetDecimals: number;
+  /**
+   * Collateral vaults this market accepts (those currently borrowable, LTV > 0), each with its LTVs.
+   */
+  collaterals?: Array<EulerMarketCollateral> | undefined;
+};
+
+/** @internal */
+export const EulerMarket$inboundSchema: z.ZodType<
+  EulerMarket,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  vault: z.string(),
+  vault_symbol: z.string(),
+  asset: z.string(),
+  asset_symbol: z.string(),
+  asset_decimals: z.number().int(),
+  collaterals: z.array(EulerMarketCollateral$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "vault_symbol": "vaultSymbol",
+    "asset_symbol": "assetSymbol",
+    "asset_decimals": "assetDecimals",
+  });
+});
+
+export function eulerMarketFromJSON(
+  jsonString: string,
+): SafeParseResult<EulerMarket, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EulerMarket$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EulerMarket' from JSON`,
+  );
+}

package/src/models/components/eulermarketcollateral.ts

@@ -0,0 +1,64 @@
+/*
+ * 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 collateral vault an Euler borrow market accepts, with its loan-to-value.
+ */
+export type EulerMarketCollateral = {
+  /**
+   * EVK collateral vault to supply into (pass as collateral_vault when borrowing).
+   */
+  vault: string;
+  /**
+   * Underlying asset of the collateral vault.
+   */
+  asset: string;
+  /**
+   * Symbol of the collateral's underlying asset (e.g. USDC).
+   */
+  assetSymbol: string;
+  /**
+   * Maximum loan-to-value when borrowing against this collateral, in percentage (e.g. 94 means 94%).
+   */
+  borrowLtv: string;
+  /**
+   * Loan-to-value at which this collateral is liquidated, in percentage (e.g. 96 means 96%).
+   */
+  liquidationLtv: string;
+};
+
+/** @internal */
+export const EulerMarketCollateral$inboundSchema: z.ZodType<
+  EulerMarketCollateral,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  vault: z.string(),
+  asset: z.string(),
+  asset_symbol: z.string(),
+  borrow_ltv: z.string(),
+  liquidation_ltv: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "asset_symbol": "assetSymbol",
+    "borrow_ltv": "borrowLtv",
+    "liquidation_ltv": "liquidationLtv",
+  });
+});
+
+export function eulerMarketCollateralFromJSON(
+  jsonString: string,
+): SafeParseResult<EulerMarketCollateral, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EulerMarketCollateral$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EulerMarketCollateral' from JSON`,
+  );
+}

package/src/models/components/eulermarketsresponse.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 { EulerMarket, EulerMarket$inboundSchema } from "./eulermarket.js";
+
+/**
+ * Curated Euler V2 borrow markets, read from Euler's Governed Perspective.
+ */
+export type EulerMarketsResponse = {
+  /**
+   * Euler Governed Perspective contract the curated vault set was read from.
+   */
+  perspective: string;
+  /**
+   * Curated borrow markets, each with its accepted collateral vaults and LTVs.
+   */
+  markets?: Array<EulerMarket> | undefined;
+};
+
+/** @internal */
+export const EulerMarketsResponse$inboundSchema: z.ZodType<
+  EulerMarketsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  perspective: z.string(),
+  markets: z.array(EulerMarket$inboundSchema).optional(),
+});
+
+export function eulerMarketsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<EulerMarketsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EulerMarketsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EulerMarketsResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -145,6 +145,9 @@ export * from "./ethenarequesttowithdrawrequest.js";
 export * from "./ethenarequesttowithdrawtransactionresponse.js";
 export * from "./ethenaunstakeparams.js";
 export * from "./ethenaunstakerequest.js";
+export * from "./eulermarket.js";
+export * from "./eulermarketcollateral.js";
+export * from "./eulermarketsresponse.js";
 export * from "./fee.js";
 export * from "./feeenum.js";
 export * from "./globalmarketsperpsactivitypartialerror.js";

package/src/models/operations/index.ts

@@ -42,6 +42,7 @@ export * from "./v1vaultsvault.js";
 export * from "./v1wildcatmarket.js";
 export * from "./v2cctpmint.js";
 export * from "./v2creditbalances.js";
+export * from "./v2crediteulermarkets.js";
 export * from "./v2creditpositions.js";
 export * from "./v2earnaavemarkets.js";
 export * from "./v2earnbalances.js";

package/src/models/operations/v2crediteulermarkets.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const V2CreditEulerMarketsChain = {
+  Arbitrum: "arbitrum",
+  Base: "base",
+  Ethereum: "ethereum",
+  Tempo: "tempo",
+} as const;
+export type V2CreditEulerMarketsChain = ClosedEnum<
+  typeof V2CreditEulerMarketsChain
+>;
+
+export type V2CreditEulerMarketsRequest = {
+  chain: V2CreditEulerMarketsChain;
+};
+
+/** @internal */
+export const V2CreditEulerMarketsChain$outboundSchema: z.ZodNativeEnum<
+  typeof V2CreditEulerMarketsChain
+> = z.nativeEnum(V2CreditEulerMarketsChain);
+
+/** @internal */
+export type V2CreditEulerMarketsRequest$Outbound = {
+  chain: string;
+};
+
+/** @internal */
+export const V2CreditEulerMarketsRequest$outboundSchema: z.ZodType<
+  V2CreditEulerMarketsRequest$Outbound,
+  z.ZodTypeDef,
+  V2CreditEulerMarketsRequest
+> = z.object({
+  chain: V2CreditEulerMarketsChain$outboundSchema,
+});
+
+export function v2CreditEulerMarketsRequestToJSON(
+  v2CreditEulerMarketsRequest: V2CreditEulerMarketsRequest,
+): string {
+  return JSON.stringify(
+    V2CreditEulerMarketsRequest$outboundSchema.parse(
+      v2CreditEulerMarketsRequest,
+    ),
+  );
+}

package/src/sdk/credit.ts

@@ -6,6 +6,7 @@ import { creditCreditBalances } from "../funcs/creditCreditBalances.js";
 import { creditCreditBorrow } from "../funcs/creditCreditBorrow.js";
 import { creditCreditBundle } from "../funcs/creditCreditBundle.js";
 import { creditCreditCreateAccount } from "../funcs/creditCreditCreateAccount.js";
+import { creditCreditEulerMarkets } from "../funcs/creditCreditEulerMarkets.js";
 import { creditCreditPositions } from "../funcs/creditCreditPositions.js";
 import { creditCreditRepay } from "../funcs/creditCreditRepay.js";
 import { creditCreditTransfer } from "../funcs/creditCreditTransfer.js";
@@ -55,6 +56,28 @@ export class Credit extends ClientSDK {
     ));
   }
 
+  /**
+   * List curated Euler markets
+   *
+   * @remarks
+   * List curated Euler V2 credit markets for a chain.
+   *
+   * Euler is permissionless, so credit borrow/repay identify a market by EVK vault
+   * address. This returns the borrow markets from Euler's Governed Perspective (the
+   * DAO-vetted vault set) -- each with the collateral vaults it accepts and their
+   * LTVs -- so callers know which borrow_vault / collateral_vault to use.
+   */
+  async creditEulerMarkets(
+    request: operations.V2CreditEulerMarketsRequest,
+    options?: RequestOptions,
+  ): Promise<components.EulerMarketsResponse> {
+    return unwrapAsync(creditCreditEulerMarkets(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Create credit account
    *