@compass-labs/api-sdk 0.5.3 → 0.5.4

package/src/models/components/pendleredeemyieldparams.ts

@@ -0,0 +1,86 @@
+/*
+ * 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 PendleRedeemYieldParams = {
+  actionType?: "PENDLE_REDEEM_YIELD" | undefined;
+  /**
+   * The address of the market identifying which Yield Token (YT) you would like to claim yield from.
+   */
+  marketAddress: string;
+};
+
+/** @internal */
+export const PendleRedeemYieldParams$inboundSchema: z.ZodType<
+  PendleRedeemYieldParams,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  action_type: z.literal("PENDLE_REDEEM_YIELD").default("PENDLE_REDEEM_YIELD"),
+  market_address: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "action_type": "actionType",
+    "market_address": "marketAddress",
+  });
+});
+
+/** @internal */
+export type PendleRedeemYieldParams$Outbound = {
+  action_type: "PENDLE_REDEEM_YIELD";
+  market_address: string;
+};
+
+/** @internal */
+export const PendleRedeemYieldParams$outboundSchema: z.ZodType<
+  PendleRedeemYieldParams$Outbound,
+  z.ZodTypeDef,
+  PendleRedeemYieldParams
+> = z.object({
+  actionType: z.literal("PENDLE_REDEEM_YIELD").default(
+    "PENDLE_REDEEM_YIELD" as const,
+  ),
+  marketAddress: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    actionType: "action_type",
+    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 PendleRedeemYieldParams$ {
+  /** @deprecated use `PendleRedeemYieldParams$inboundSchema` instead. */
+  export const inboundSchema = PendleRedeemYieldParams$inboundSchema;
+  /** @deprecated use `PendleRedeemYieldParams$outboundSchema` instead. */
+  export const outboundSchema = PendleRedeemYieldParams$outboundSchema;
+  /** @deprecated use `PendleRedeemYieldParams$Outbound` instead. */
+  export type Outbound = PendleRedeemYieldParams$Outbound;
+}
+
+export function pendleRedeemYieldParamsToJSON(
+  pendleRedeemYieldParams: PendleRedeemYieldParams,
+): string {
+  return JSON.stringify(
+    PendleRedeemYieldParams$outboundSchema.parse(pendleRedeemYieldParams),
+  );
+}
+
+export function pendleRedeemYieldParamsFromJSON(
+  jsonString: string,
+): SafeParseResult<PendleRedeemYieldParams, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PendleRedeemYieldParams$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PendleRedeemYieldParams' from JSON`,
+  );
+}

package/src/models/components/pendleredeemyieldrequest.ts

@@ -0,0 +1,101 @@
+/*
+ * 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";
+import { Chain, Chain$inboundSchema, Chain$outboundSchema } from "./chain.js";
+
+export type PendleRedeemYieldRequest = {
+  actionType?: "PENDLE_REDEEM_YIELD" | undefined;
+  /**
+   * The address of the market identifying which Yield Token (YT) you would like to claim yield from.
+   */
+  marketAddress: string;
+  /**
+   * The chain to use.
+   */
+  chain: Chain;
+  /**
+   * The address of the transaction sender.
+   */
+  sender: string;
+};
+
+/** @internal */
+export const PendleRedeemYieldRequest$inboundSchema: z.ZodType<
+  PendleRedeemYieldRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  action_type: z.literal("PENDLE_REDEEM_YIELD").default("PENDLE_REDEEM_YIELD"),
+  market_address: z.string(),
+  chain: Chain$inboundSchema,
+  sender: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "action_type": "actionType",
+    "market_address": "marketAddress",
+  });
+});
+
+/** @internal */
+export type PendleRedeemYieldRequest$Outbound = {
+  action_type: "PENDLE_REDEEM_YIELD";
+  market_address: string;
+  chain: string;
+  sender: string;
+};
+
+/** @internal */
+export const PendleRedeemYieldRequest$outboundSchema: z.ZodType<
+  PendleRedeemYieldRequest$Outbound,
+  z.ZodTypeDef,
+  PendleRedeemYieldRequest
+> = z.object({
+  actionType: z.literal("PENDLE_REDEEM_YIELD").default(
+    "PENDLE_REDEEM_YIELD" as const,
+  ),
+  marketAddress: z.string(),
+  chain: Chain$outboundSchema,
+  sender: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    actionType: "action_type",
+    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 PendleRedeemYieldRequest$ {
+  /** @deprecated use `PendleRedeemYieldRequest$inboundSchema` instead. */
+  export const inboundSchema = PendleRedeemYieldRequest$inboundSchema;
+  /** @deprecated use `PendleRedeemYieldRequest$outboundSchema` instead. */
+  export const outboundSchema = PendleRedeemYieldRequest$outboundSchema;
+  /** @deprecated use `PendleRedeemYieldRequest$Outbound` instead. */
+  export type Outbound = PendleRedeemYieldRequest$Outbound;
+}
+
+export function pendleRedeemYieldRequestToJSON(
+  pendleRedeemYieldRequest: PendleRedeemYieldRequest,
+): string {
+  return JSON.stringify(
+    PendleRedeemYieldRequest$outboundSchema.parse(pendleRedeemYieldRequest),
+  );
+}
+
+export function pendleRedeemYieldRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<PendleRedeemYieldRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PendleRedeemYieldRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PendleRedeemYieldRequest' from JSON`,
+  );
+}

package/src/models/components/useroperation.ts

@@ -120,6 +120,12 @@ import {
   PendleBuyYtParams$Outbound,
   PendleBuyYtParams$outboundSchema,
 } from "./pendlebuyytparams.js";
+import {
+  PendleRedeemYieldParams,
+  PendleRedeemYieldParams$inboundSchema,
+  PendleRedeemYieldParams$Outbound,
+  PendleRedeemYieldParams$outboundSchema,
+} from "./pendleredeemyieldparams.js";
 import {
   PendleSellPtParams,
   PendleSellPtParams$inboundSchema,
@@ -206,6 +212,7 @@ import {
 } from "./wrapethparams.js";
 
 export type Body =
+  | (PendleRedeemYieldParams & { actionType: "PENDLE_REDEEM_YIELD" })
   | (UnwrapWethParams & { actionType: "UNWRAP_WETH" })
   | (WrapEthParams & { actionType: "WRAP_ETH" })
   | (AerodromeSlipstreamWithdrawLiquidityProvisionParams & {
@@ -262,6 +269,7 @@ export type Body =
 
 export type UserOperation = {
   body:
+    | (PendleRedeemYieldParams & { actionType: "PENDLE_REDEEM_YIELD" })
     | (UnwrapWethParams & { actionType: "UNWRAP_WETH" })
     | (WrapEthParams & { actionType: "WRAP_ETH" })
     | (AerodromeSlipstreamWithdrawLiquidityProvisionParams & {
@@ -322,6 +330,11 @@ export type UserOperation = {
 /** @internal */
 export const Body$inboundSchema: z.ZodType<Body, z.ZodTypeDef, unknown> = z
   .union([
+    PendleRedeemYieldParams$inboundSchema.and(
+      z.object({ action_type: z.literal("PENDLE_REDEEM_YIELD") }).transform((
+        v,
+      ) => ({ actionType: v.action_type })),
+    ),
     UnwrapWethParams$inboundSchema.and(
       z.object({ action_type: z.literal("UNWRAP_WETH") }).transform((v) => ({
         actionType: v.action_type,
@@ -489,6 +502,7 @@ export const Body$inboundSchema: z.ZodType<Body, z.ZodTypeDef, unknown> = z
 
 /** @internal */
 export type Body$Outbound =
+  | (PendleRedeemYieldParams$Outbound & { action_type: "PENDLE_REDEEM_YIELD" })
   | (UnwrapWethParams$Outbound & { action_type: "UNWRAP_WETH" })
   | (WrapEthParams$Outbound & { action_type: "WRAP_ETH" })
   | (AerodromeSlipstreamWithdrawLiquidityProvisionParams$Outbound & {
@@ -552,6 +566,11 @@ export type Body$Outbound =
 /** @internal */
 export const Body$outboundSchema: z.ZodType<Body$Outbound, z.ZodTypeDef, Body> =
   z.union([
+    PendleRedeemYieldParams$outboundSchema.and(
+      z.object({ actionType: z.literal("PENDLE_REDEEM_YIELD") }).transform((
+        v,
+      ) => ({ action_type: v.actionType })),
+    ),
     UnwrapWethParams$outboundSchema.and(
       z.object({ actionType: z.literal("UNWRAP_WETH") }).transform((v) => ({
         action_type: v.actionType,
@@ -752,6 +771,11 @@ export const UserOperation$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   body: z.union([
+    PendleRedeemYieldParams$inboundSchema.and(
+      z.object({ action_type: z.literal("PENDLE_REDEEM_YIELD") }).transform((
+        v,
+      ) => ({ actionType: v.action_type })),
+    ),
     UnwrapWethParams$inboundSchema.and(
       z.object({ action_type: z.literal("UNWRAP_WETH") }).transform((v) => ({
         actionType: v.action_type,
@@ -921,6 +945,9 @@ export const UserOperation$inboundSchema: z.ZodType<
 /** @internal */
 export type UserOperation$Outbound = {
   body:
+    | (PendleRedeemYieldParams$Outbound & {
+      action_type: "PENDLE_REDEEM_YIELD";
+    })
     | (UnwrapWethParams$Outbound & { action_type: "UNWRAP_WETH" })
     | (WrapEthParams$Outbound & { action_type: "WRAP_ETH" })
     | (AerodromeSlipstreamWithdrawLiquidityProvisionParams$Outbound & {
@@ -991,6 +1018,11 @@ export const UserOperation$outboundSchema: z.ZodType<
   UserOperation
 > = z.object({
   body: z.union([
+    PendleRedeemYieldParams$outboundSchema.and(
+      z.object({ actionType: z.literal("PENDLE_REDEEM_YIELD") }).transform((
+        v,
+      ) => ({ action_type: v.actionType })),
+    ),
     UnwrapWethParams$outboundSchema.and(
       z.object({ actionType: z.literal("UNWRAP_WETH") }).transform((v) => ({
         action_type: v.actionType,

package/src/sdk/pendle.ts

@@ -8,6 +8,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 { pendleRedeemYield } from "../funcs/pendleRedeemYield.js";
 import { pendleSellPt } from "../funcs/pendleSellPt.js";
 import { pendleSellYt } from "../funcs/pendleSellYt.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -151,4 +152,21 @@ export class Pendle extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Redeem Claimable Yield
+   *
+   * @remarks
+   * Redeem claimable yield from the market's associated Yield Token (YT).
+   */
+  async redeemYield(
+    request: components.PendleRedeemYieldRequest,
+    options?: RequestOptions,
+  ): Promise<components.TxResponse> {
+    return unwrapAsync(pendleRedeemYield(
+      this,
+      request,
+      options,
+    ));
+  }
 }