@compass-labs/api-sdk 0.5.39 → 0.5.41

package/src/models/components/index.ts

@@ -96,6 +96,7 @@ export * from "./pendlebuyptrequest.js";
 export * from "./pendlebuyytparams.js";
 export * from "./pendlebuyytrequest.js";
 export * from "./pendlegetmarketresponse.js";
+export * from "./pendlegetquoteresponse.js";
 export * from "./pendlegetuserpositionresponse.js";
 export * from "./pendlelistmarketsresponse.js";
 export * from "./pendlelistuserpositionsresponse.js";

package/src/models/components/pendlegetquoteresponse.ts

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PendleGetQuoteResponse = {
+  /**
+   * A quote for the specified trade, detailing the expected amount of tokens received based on the `trade_type` and `token_type`.
+   */
+  quote: string;
+};
+
+/** @internal */
+export const PendleGetQuoteResponse$inboundSchema: z.ZodType<
+  PendleGetQuoteResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  quote: z.string(),
+});
+
+/** @internal */
+export type PendleGetQuoteResponse$Outbound = {
+  quote: string;
+};
+
+/** @internal */
+export const PendleGetQuoteResponse$outboundSchema: z.ZodType<
+  PendleGetQuoteResponse$Outbound,
+  z.ZodTypeDef,
+  PendleGetQuoteResponse
+> = z.object({
+  quote: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PendleGetQuoteResponse$ {
+  /** @deprecated use `PendleGetQuoteResponse$inboundSchema` instead. */
+  export const inboundSchema = PendleGetQuoteResponse$inboundSchema;
+  /** @deprecated use `PendleGetQuoteResponse$outboundSchema` instead. */
+  export const outboundSchema = PendleGetQuoteResponse$outboundSchema;
+  /** @deprecated use `PendleGetQuoteResponse$Outbound` instead. */
+  export type Outbound = PendleGetQuoteResponse$Outbound;
+}
+
+export function pendleGetQuoteResponseToJSON(
+  pendleGetQuoteResponse: PendleGetQuoteResponse,
+): string {
+  return JSON.stringify(
+    PendleGetQuoteResponse$outboundSchema.parse(pendleGetQuoteResponse),
+  );
+}
+
+export function pendleGetQuoteResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PendleGetQuoteResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PendleGetQuoteResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PendleGetQuoteResponse' from JSON`,
+  );
+}

package/src/models/components/vaultgetvaultresponse.ts

@@ -56,7 +56,7 @@ export type VaultGetVaultResponse = {
   /**
    * The user's position in the vault.
    */
-  userPosition: UserPosition | null;
+  userPosition?: UserPosition | null | undefined;
 };
 
 /** @internal */
@@ -73,7 +73,7 @@ export const VaultGetVaultResponse$inboundSchema: z.ZodType<
   share_price: z.string(),
   asset: CompassApiBackendModelsVaultsReadResponseVaultAsset$inboundSchema,
   apy: Apy$inboundSchema,
-  user_position: z.nullable(UserPosition$inboundSchema),
+  user_position: z.nullable(UserPosition$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     "total_assets": "totalAssets",
@@ -93,7 +93,7 @@ export type VaultGetVaultResponse$Outbound = {
   share_price: string;
   asset: CompassApiBackendModelsVaultsReadResponseVaultAsset$Outbound;
   apy: Apy$Outbound;
-  user_position: UserPosition$Outbound | null;
+  user_position?: UserPosition$Outbound | null | undefined;
 };
 
 /** @internal */
@@ -110,7 +110,7 @@ export const VaultGetVaultResponse$outboundSchema: z.ZodType<
   sharePrice: z.string(),
   asset: CompassApiBackendModelsVaultsReadResponseVaultAsset$outboundSchema,
   apy: Apy$outboundSchema,
-  userPosition: z.nullable(UserPosition$outboundSchema),
+  userPosition: z.nullable(UserPosition$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     totalAssets: "total_assets",

package/src/models/operations/index.ts

@@ -28,6 +28,7 @@ export * from "./pendlemarket.js";
 export * from "./pendlemarkets.js";
 export * from "./pendleposition.js";
 export * from "./pendlepositions.js";
+export * from "./pendlequote.js";
 export * from "./skyposition.js";
 export * from "./tokenaddress.js";
 export * from "./tokenbalance.js";

package/src/models/operations/pendlequote.ts

@@ -0,0 +1,265 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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";
+
+/**
+ * The chain to use.
+ */
+export const PendleQuoteChain = {
+  BaseMainnet: "base:mainnet",
+  EthereumMainnet: "ethereum:mainnet",
+  ArbitrumMainnet: "arbitrum:mainnet",
+} as const;
+/**
+ * The chain to use.
+ */
+export type PendleQuoteChain = ClosedEnum<typeof PendleQuoteChain>;
+
+/**
+ * The quantity to trade.
+ */
+export type Amount = number | string;
+
+/**
+ * Specifies the token to quote (`PT`, `YT`, or `LP`)
+ */
+export const TokenType = {
+  Pt: "PT",
+  Yt: "YT",
+  Lp: "LP",
+} as const;
+/**
+ * Specifies the token to quote (`PT`, `YT`, or `LP`)
+ */
+export type TokenType = ClosedEnum<typeof TokenType>;
+
+/**
+ * Specifies the trade direction (`BUY` or `SELL`)
+ */
+export const TradeType = {
+  Buy: "BUY",
+  Sell: "SELL",
+} as const;
+/**
+ * Specifies the trade direction (`BUY` or `SELL`)
+ */
+export type TradeType = ClosedEnum<typeof TradeType>;
+
+export type PendleQuoteRequest = {
+  /**
+   * The chain to use.
+   */
+  chain?: PendleQuoteChain | undefined;
+  /**
+   * Optional block number (defaults to latest).
+   */
+  block?: number | null | undefined;
+  /**
+   * The market address of the desired position.
+   */
+  marketAddress?: string | undefined;
+  /**
+   * The quantity to trade.
+   */
+  amount: number | string;
+  /**
+   * Specifies the token to quote (`PT`, `YT`, or `LP`)
+   */
+  tokenType?: TokenType | undefined;
+  /**
+   * Specifies the trade direction (`BUY` or `SELL`)
+   */
+  tradeType?: TradeType | undefined;
+};
+
+/** @internal */
+export const PendleQuoteChain$inboundSchema: z.ZodNativeEnum<
+  typeof PendleQuoteChain
+> = z.nativeEnum(PendleQuoteChain);
+
+/** @internal */
+export const PendleQuoteChain$outboundSchema: z.ZodNativeEnum<
+  typeof PendleQuoteChain
+> = PendleQuoteChain$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PendleQuoteChain$ {
+  /** @deprecated use `PendleQuoteChain$inboundSchema` instead. */
+  export const inboundSchema = PendleQuoteChain$inboundSchema;
+  /** @deprecated use `PendleQuoteChain$outboundSchema` instead. */
+  export const outboundSchema = PendleQuoteChain$outboundSchema;
+}
+
+/** @internal */
+export const Amount$inboundSchema: z.ZodType<Amount, z.ZodTypeDef, unknown> = z
+  .union([z.number(), z.string()]);
+
+/** @internal */
+export type Amount$Outbound = number | string;
+
+/** @internal */
+export const Amount$outboundSchema: z.ZodType<
+  Amount$Outbound,
+  z.ZodTypeDef,
+  Amount
+> = z.union([z.number(), z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Amount$ {
+  /** @deprecated use `Amount$inboundSchema` instead. */
+  export const inboundSchema = Amount$inboundSchema;
+  /** @deprecated use `Amount$outboundSchema` instead. */
+  export const outboundSchema = Amount$outboundSchema;
+  /** @deprecated use `Amount$Outbound` instead. */
+  export type Outbound = Amount$Outbound;
+}
+
+export function amountToJSON(amount: Amount): string {
+  return JSON.stringify(Amount$outboundSchema.parse(amount));
+}
+
+export function amountFromJSON(
+  jsonString: string,
+): SafeParseResult<Amount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Amount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Amount' from JSON`,
+  );
+}
+
+/** @internal */
+export const TokenType$inboundSchema: z.ZodNativeEnum<typeof TokenType> = z
+  .nativeEnum(TokenType);
+
+/** @internal */
+export const TokenType$outboundSchema: z.ZodNativeEnum<typeof TokenType> =
+  TokenType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TokenType$ {
+  /** @deprecated use `TokenType$inboundSchema` instead. */
+  export const inboundSchema = TokenType$inboundSchema;
+  /** @deprecated use `TokenType$outboundSchema` instead. */
+  export const outboundSchema = TokenType$outboundSchema;
+}
+
+/** @internal */
+export const TradeType$inboundSchema: z.ZodNativeEnum<typeof TradeType> = z
+  .nativeEnum(TradeType);
+
+/** @internal */
+export const TradeType$outboundSchema: z.ZodNativeEnum<typeof TradeType> =
+  TradeType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TradeType$ {
+  /** @deprecated use `TradeType$inboundSchema` instead. */
+  export const inboundSchema = TradeType$inboundSchema;
+  /** @deprecated use `TradeType$outboundSchema` instead. */
+  export const outboundSchema = TradeType$outboundSchema;
+}
+
+/** @internal */
+export const PendleQuoteRequest$inboundSchema: z.ZodType<
+  PendleQuoteRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chain: PendleQuoteChain$inboundSchema.default("arbitrum:mainnet"),
+  block: z.nullable(z.number().int()).optional(),
+  market_address: z.string().default(
+    "0x46d62a8dede1bf2d0de04f2ed863245cbba5e538",
+  ),
+  amount: z.union([z.number(), z.string()]),
+  token_type: TokenType$inboundSchema.default("PT"),
+  trade_type: TradeType$inboundSchema.default("BUY"),
+}).transform((v) => {
+  return remap$(v, {
+    "market_address": "marketAddress",
+    "token_type": "tokenType",
+    "trade_type": "tradeType",
+  });
+});
+
+/** @internal */
+export type PendleQuoteRequest$Outbound = {
+  chain: string;
+  block?: number | null | undefined;
+  market_address: string;
+  amount: number | string;
+  token_type: string;
+  trade_type: string;
+};
+
+/** @internal */
+export const PendleQuoteRequest$outboundSchema: z.ZodType<
+  PendleQuoteRequest$Outbound,
+  z.ZodTypeDef,
+  PendleQuoteRequest
+> = z.object({
+  chain: PendleQuoteChain$outboundSchema.default("arbitrum:mainnet"),
+  block: z.nullable(z.number().int()).optional(),
+  marketAddress: z.string().default(
+    "0x46d62a8dede1bf2d0de04f2ed863245cbba5e538",
+  ),
+  amount: z.union([z.number(), z.string()]),
+  tokenType: TokenType$outboundSchema.default("PT"),
+  tradeType: TradeType$outboundSchema.default("BUY"),
+}).transform((v) => {
+  return remap$(v, {
+    marketAddress: "market_address",
+    tokenType: "token_type",
+    tradeType: "trade_type",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PendleQuoteRequest$ {
+  /** @deprecated use `PendleQuoteRequest$inboundSchema` instead. */
+  export const inboundSchema = PendleQuoteRequest$inboundSchema;
+  /** @deprecated use `PendleQuoteRequest$outboundSchema` instead. */
+  export const outboundSchema = PendleQuoteRequest$outboundSchema;
+  /** @deprecated use `PendleQuoteRequest$Outbound` instead. */
+  export type Outbound = PendleQuoteRequest$Outbound;
+}
+
+export function pendleQuoteRequestToJSON(
+  pendleQuoteRequest: PendleQuoteRequest,
+): string {
+  return JSON.stringify(
+    PendleQuoteRequest$outboundSchema.parse(pendleQuoteRequest),
+  );
+}
+
+export function pendleQuoteRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<PendleQuoteRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PendleQuoteRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PendleQuoteRequest' from JSON`,
+  );
+}

package/src/sdk/pendle.ts

@@ -9,6 +9,7 @@ import { pendleMarket } from "../funcs/pendleMarket.js";
 import { pendleMarkets } from "../funcs/pendleMarkets.js";
 import { pendlePosition } from "../funcs/pendlePosition.js";
 import { pendlePositions } from "../funcs/pendlePositions.js";
+import { pendleQuote } from "../funcs/pendleQuote.js";
 import { pendleRedeemYield } from "../funcs/pendleRedeemYield.js";
 import { pendleRemoveLiquidity } from "../funcs/pendleRemoveLiquidity.js";
 import { pendleSellPt } from "../funcs/pendleSellPt.js";
@@ -87,6 +88,28 @@ export class Pendle extends ClientSDK {
     ));
   }
 
+  /**
+   * Get Quote
+   *
+   * @remarks
+   * Retrieve a quote for trading Principal Token (PT), Yield Token (YT), or Liquidity
+   * Provider Token (LP) on Pendle.
+   *
+   * For `BUY`, `amount` is the quantity of the Underlying Token to spend, and the quote returns the amount of `token_type` received.
+   *
+   * For `SELL`, `amount` is the quantity of `token_type` to sell, and the quote returns the amount of Underlying Token received.
+   */
+  async quote(
+    request: operations.PendleQuoteRequest,
+    options?: RequestOptions,
+  ): Promise<components.PendleGetQuoteResponse> {
+    return unwrapAsync(pendleQuote(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Buy Principal Token (PT)
    *