@compass-labs/api-sdk 0.1.5 → 0.1.7

package/src/models/components/pendlegetuserpositionresponse.ts

@@ -0,0 +1,145 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PendleGetUserPositionResponse = {
+  /**
+   * The amount of yield that can be claimed in the underlying token.
+   */
+  claimableYield: string;
+  /**
+   * The amount of SY tokens the user currently holds.
+   */
+  syBalance: string;
+  /**
+   * The amount of PT tokens the user currently holds.
+   */
+  ptBalance: string;
+  /**
+   * The amount of YT tokens the user currently holds.
+   */
+  ytBalance: string;
+  /**
+   * The amount of underlying tokens the user currently holds.
+   */
+  underlyingTokenBalance: string;
+  /**
+   * The name of the underlying token.
+   */
+  underlyingTokenName: string;
+  /**
+   * The symbol of the underlying token.
+   */
+  underlyingTokenSymbol: string;
+  /**
+   * The maturity date of the market. ISO 8601 format. UTC timezone.
+   */
+  maturityDate: Date;
+};
+
+/** @internal */
+export const PendleGetUserPositionResponse$inboundSchema: z.ZodType<
+  PendleGetUserPositionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  claimable_yield: z.string(),
+  sy_balance: z.string(),
+  pt_balance: z.string(),
+  yt_balance: z.string(),
+  underlying_token_balance: z.string(),
+  underlying_token_name: z.string(),
+  underlying_token_symbol: z.string(),
+  maturity_date: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "claimable_yield": "claimableYield",
+    "sy_balance": "syBalance",
+    "pt_balance": "ptBalance",
+    "yt_balance": "ytBalance",
+    "underlying_token_balance": "underlyingTokenBalance",
+    "underlying_token_name": "underlyingTokenName",
+    "underlying_token_symbol": "underlyingTokenSymbol",
+    "maturity_date": "maturityDate",
+  });
+});
+
+/** @internal */
+export type PendleGetUserPositionResponse$Outbound = {
+  claimable_yield: string;
+  sy_balance: string;
+  pt_balance: string;
+  yt_balance: string;
+  underlying_token_balance: string;
+  underlying_token_name: string;
+  underlying_token_symbol: string;
+  maturity_date: string;
+};
+
+/** @internal */
+export const PendleGetUserPositionResponse$outboundSchema: z.ZodType<
+  PendleGetUserPositionResponse$Outbound,
+  z.ZodTypeDef,
+  PendleGetUserPositionResponse
+> = z.object({
+  claimableYield: z.string(),
+  syBalance: z.string(),
+  ptBalance: z.string(),
+  ytBalance: z.string(),
+  underlyingTokenBalance: z.string(),
+  underlyingTokenName: z.string(),
+  underlyingTokenSymbol: z.string(),
+  maturityDate: z.date().transform(v => v.toISOString()),
+}).transform((v) => {
+  return remap$(v, {
+    claimableYield: "claimable_yield",
+    syBalance: "sy_balance",
+    ptBalance: "pt_balance",
+    ytBalance: "yt_balance",
+    underlyingTokenBalance: "underlying_token_balance",
+    underlyingTokenName: "underlying_token_name",
+    underlyingTokenSymbol: "underlying_token_symbol",
+    maturityDate: "maturity_date",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PendleGetUserPositionResponse$ {
+  /** @deprecated use `PendleGetUserPositionResponse$inboundSchema` instead. */
+  export const inboundSchema = PendleGetUserPositionResponse$inboundSchema;
+  /** @deprecated use `PendleGetUserPositionResponse$outboundSchema` instead. */
+  export const outboundSchema = PendleGetUserPositionResponse$outboundSchema;
+  /** @deprecated use `PendleGetUserPositionResponse$Outbound` instead. */
+  export type Outbound = PendleGetUserPositionResponse$Outbound;
+}
+
+export function pendleGetUserPositionResponseToJSON(
+  pendleGetUserPositionResponse: PendleGetUserPositionResponse,
+): string {
+  return JSON.stringify(
+    PendleGetUserPositionResponse$outboundSchema.parse(
+      pendleGetUserPositionResponse,
+    ),
+  );
+}
+
+export function pendleGetUserPositionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PendleGetUserPositionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PendleGetUserPositionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PendleGetUserPositionResponse' from JSON`,
+  );
+}

package/src/models/operations/genericallowance.ts

@@ -101,6 +101,7 @@ export const ContractName = {
   SkyDaiUsdsConverter: "SkyDaiUsdsConverter",
   SkyUsdcUsdsConverter: "SkyUsdcUsdsConverter",
   SkyUsdsVault: "SkyUsdsVault",
+  PendleRouter: "PendleRouter",
 } as const;
 /**
  * The name of the contract to check allowance for.

package/src/models/operations/index.ts

@@ -25,6 +25,8 @@ export * from "./morphouserposition.js";
 export * from "./morphovault.js";
 export * from "./morphovaultposition.js";
 export * from "./morphovaults.js";
+export * from "./pendlemarket.js";
+export * from "./pendleposition.js";
 export * from "./skyposition.js";
 export * from "./tokenaddress.js";
 export * from "./tokenbalance.js";

package/src/models/operations/pendlemarket.ts

@@ -0,0 +1,135 @@
+/*
+ * 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 PendleMarketChain = {
+  BaseMainnet: "base:mainnet",
+  EthereumMainnet: "ethereum:mainnet",
+  ArbitrumMainnet: "arbitrum:mainnet",
+} as const;
+/**
+ * The chain to use.
+ */
+export type PendleMarketChain = ClosedEnum<typeof PendleMarketChain>;
+
+export type PendleMarketRequest = {
+  /**
+   * The chain to use.
+   */
+  chain?: PendleMarketChain | undefined;
+  /**
+   * The user address of the desired position.
+   */
+  userAddress?: string | undefined;
+  /**
+   * The market address of the desired position.
+   */
+  marketAddress?: string | undefined;
+};
+
+/** @internal */
+export const PendleMarketChain$inboundSchema: z.ZodNativeEnum<
+  typeof PendleMarketChain
+> = z.nativeEnum(PendleMarketChain);
+
+/** @internal */
+export const PendleMarketChain$outboundSchema: z.ZodNativeEnum<
+  typeof PendleMarketChain
+> = PendleMarketChain$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PendleMarketChain$ {
+  /** @deprecated use `PendleMarketChain$inboundSchema` instead. */
+  export const inboundSchema = PendleMarketChain$inboundSchema;
+  /** @deprecated use `PendleMarketChain$outboundSchema` instead. */
+  export const outboundSchema = PendleMarketChain$outboundSchema;
+}
+
+/** @internal */
+export const PendleMarketRequest$inboundSchema: z.ZodType<
+  PendleMarketRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chain: PendleMarketChain$inboundSchema.default("ethereum:mainnet"),
+  user_address: z.string().default(
+    "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
+  ),
+  market_address: z.string().default(
+    "0xdace1121e10500e9e29d071f01593fd76b000f08",
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "user_address": "userAddress",
+    "market_address": "marketAddress",
+  });
+});
+
+/** @internal */
+export type PendleMarketRequest$Outbound = {
+  chain: string;
+  user_address: string;
+  market_address: string;
+};
+
+/** @internal */
+export const PendleMarketRequest$outboundSchema: z.ZodType<
+  PendleMarketRequest$Outbound,
+  z.ZodTypeDef,
+  PendleMarketRequest
+> = z.object({
+  chain: PendleMarketChain$outboundSchema.default("ethereum:mainnet"),
+  userAddress: z.string().default("0xa829B388A3DF7f581cE957a95edbe419dd146d1B"),
+  marketAddress: z.string().default(
+    "0xdace1121e10500e9e29d071f01593fd76b000f08",
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    userAddress: "user_address",
+    marketAddress: "market_address",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PendleMarketRequest$ {
+  /** @deprecated use `PendleMarketRequest$inboundSchema` instead. */
+  export const inboundSchema = PendleMarketRequest$inboundSchema;
+  /** @deprecated use `PendleMarketRequest$outboundSchema` instead. */
+  export const outboundSchema = PendleMarketRequest$outboundSchema;
+  /** @deprecated use `PendleMarketRequest$Outbound` instead. */
+  export type Outbound = PendleMarketRequest$Outbound;
+}
+
+export function pendleMarketRequestToJSON(
+  pendleMarketRequest: PendleMarketRequest,
+): string {
+  return JSON.stringify(
+    PendleMarketRequest$outboundSchema.parse(pendleMarketRequest),
+  );
+}
+
+export function pendleMarketRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<PendleMarketRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PendleMarketRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PendleMarketRequest' from JSON`,
+  );
+}

package/src/models/operations/pendleposition.ts

@@ -0,0 +1,135 @@
+/*
+ * 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 PendlePositionChain = {
+  BaseMainnet: "base:mainnet",
+  EthereumMainnet: "ethereum:mainnet",
+  ArbitrumMainnet: "arbitrum:mainnet",
+} as const;
+/**
+ * The chain to use.
+ */
+export type PendlePositionChain = ClosedEnum<typeof PendlePositionChain>;
+
+export type PendlePositionRequest = {
+  /**
+   * The chain to use.
+   */
+  chain?: PendlePositionChain | undefined;
+  /**
+   * The user address of the desired position.
+   */
+  userAddress?: string | undefined;
+  /**
+   * The market address of the desired position.
+   */
+  marketAddress?: string | undefined;
+};
+
+/** @internal */
+export const PendlePositionChain$inboundSchema: z.ZodNativeEnum<
+  typeof PendlePositionChain
+> = z.nativeEnum(PendlePositionChain);
+
+/** @internal */
+export const PendlePositionChain$outboundSchema: z.ZodNativeEnum<
+  typeof PendlePositionChain
+> = PendlePositionChain$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PendlePositionChain$ {
+  /** @deprecated use `PendlePositionChain$inboundSchema` instead. */
+  export const inboundSchema = PendlePositionChain$inboundSchema;
+  /** @deprecated use `PendlePositionChain$outboundSchema` instead. */
+  export const outboundSchema = PendlePositionChain$outboundSchema;
+}
+
+/** @internal */
+export const PendlePositionRequest$inboundSchema: z.ZodType<
+  PendlePositionRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chain: PendlePositionChain$inboundSchema.default("ethereum:mainnet"),
+  user_address: z.string().default(
+    "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
+  ),
+  market_address: z.string().default(
+    "0xdace1121e10500e9e29d071f01593fd76b000f08",
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "user_address": "userAddress",
+    "market_address": "marketAddress",
+  });
+});
+
+/** @internal */
+export type PendlePositionRequest$Outbound = {
+  chain: string;
+  user_address: string;
+  market_address: string;
+};
+
+/** @internal */
+export const PendlePositionRequest$outboundSchema: z.ZodType<
+  PendlePositionRequest$Outbound,
+  z.ZodTypeDef,
+  PendlePositionRequest
+> = z.object({
+  chain: PendlePositionChain$outboundSchema.default("ethereum:mainnet"),
+  userAddress: z.string().default("0xa829B388A3DF7f581cE957a95edbe419dd146d1B"),
+  marketAddress: z.string().default(
+    "0xdace1121e10500e9e29d071f01593fd76b000f08",
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    userAddress: "user_address",
+    marketAddress: "market_address",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PendlePositionRequest$ {
+  /** @deprecated use `PendlePositionRequest$inboundSchema` instead. */
+  export const inboundSchema = PendlePositionRequest$inboundSchema;
+  /** @deprecated use `PendlePositionRequest$outboundSchema` instead. */
+  export const outboundSchema = PendlePositionRequest$outboundSchema;
+  /** @deprecated use `PendlePositionRequest$Outbound` instead. */
+  export type Outbound = PendlePositionRequest$Outbound;
+}
+
+export function pendlePositionRequestToJSON(
+  pendlePositionRequest: PendlePositionRequest,
+): string {
+  return JSON.stringify(
+    PendlePositionRequest$outboundSchema.parse(pendlePositionRequest),
+  );
+}
+
+export function pendlePositionRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<PendlePositionRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PendlePositionRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PendlePositionRequest' from JSON`,
+  );
+}

package/src/sdk/pendle.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { pendleMarket } from "../funcs/pendleMarket.js";
+import { pendlePosition } from "../funcs/pendlePosition.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Pendle extends ClientSDK {
+  /**
+   * Check User's Market Position
+   *
+   * @remarks
+   * Check the SY, PT, and YT positions for a given market.
+   */
+  async position(
+    request: operations.PendlePositionRequest,
+    options?: RequestOptions,
+  ): Promise<components.PendleGetUserPositionResponse> {
+    return unwrapAsync(pendlePosition(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Market Data
+   *
+   * @remarks
+   * Get market data.
+   */
+  async market(
+    request: operations.PendleMarketRequest,
+    options?: RequestOptions,
+  ): Promise<components.PendleGetMarketResponse> {
+    return unwrapAsync(pendleMarket(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -6,6 +6,7 @@ import { ClientSDK } from "../lib/sdks.js";
 import { AaveV3 } from "./aavev3.js";
 import { AerodromeSlipstream } from "./aerodromeslipstream.js";
 import { Morpho } from "./morpho.js";
+import { Pendle } from "./pendle.js";
 import { Sky } from "./sky.js";
 import { SmartAccount } from "./smartaccount.js";
 import { Token } from "./token.js";
@@ -51,6 +52,11 @@ export class CompassApiSDK extends ClientSDK {
     return (this._universal ??= new Universal(this._options));
   }
 
+  private _pendle?: Pendle;
+  get pendle(): Pendle {
+    return (this._pendle ??= new Pendle(this._options));
+  }
+
   private _transactionBatching?: TransactionBatching;
   get transactionBatching(): TransactionBatching {
     return (this._transactionBatching ??= new TransactionBatching(