@compass-labs/api-sdk 0.5.13 → 0.5.15

package/src/models/components/multicallexecuterequest.ts

@@ -0,0 +1,112 @@
+/*
+ * 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";
+import {
+  SignedAuthorization,
+  SignedAuthorization$inboundSchema,
+  SignedAuthorization$Outbound,
+  SignedAuthorization$outboundSchema,
+} from "./signedauthorization.js";
+import {
+  UserOperation,
+  UserOperation$inboundSchema,
+  UserOperation$Outbound,
+  UserOperation$outboundSchema,
+} from "./useroperation.js";
+
+/**
+ * Request model for executing a multicall.
+ */
+export type MulticallExecuteRequest = {
+  /**
+   * The chain to use.
+   */
+  chain: Chain;
+  /**
+   * The address of the transaction sender.
+   */
+  sender: string;
+  signedAuthorization: SignedAuthorization;
+  /**
+   * List of possible actions for multicall
+   */
+  actions: Array<UserOperation>;
+};
+
+/** @internal */
+export const MulticallExecuteRequest$inboundSchema: z.ZodType<
+  MulticallExecuteRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chain: Chain$inboundSchema,
+  sender: z.string(),
+  signed_authorization: SignedAuthorization$inboundSchema,
+  actions: z.array(UserOperation$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "signed_authorization": "signedAuthorization",
+  });
+});
+
+/** @internal */
+export type MulticallExecuteRequest$Outbound = {
+  chain: string;
+  sender: string;
+  signed_authorization: SignedAuthorization$Outbound;
+  actions: Array<UserOperation$Outbound>;
+};
+
+/** @internal */
+export const MulticallExecuteRequest$outboundSchema: z.ZodType<
+  MulticallExecuteRequest$Outbound,
+  z.ZodTypeDef,
+  MulticallExecuteRequest
+> = z.object({
+  chain: Chain$outboundSchema,
+  sender: z.string(),
+  signedAuthorization: SignedAuthorization$outboundSchema,
+  actions: z.array(UserOperation$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    signedAuthorization: "signed_authorization",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MulticallExecuteRequest$ {
+  /** @deprecated use `MulticallExecuteRequest$inboundSchema` instead. */
+  export const inboundSchema = MulticallExecuteRequest$inboundSchema;
+  /** @deprecated use `MulticallExecuteRequest$outboundSchema` instead. */
+  export const outboundSchema = MulticallExecuteRequest$outboundSchema;
+  /** @deprecated use `MulticallExecuteRequest$Outbound` instead. */
+  export type Outbound = MulticallExecuteRequest$Outbound;
+}
+
+export function multicallExecuteRequestToJSON(
+  multicallExecuteRequest: MulticallExecuteRequest,
+): string {
+  return JSON.stringify(
+    MulticallExecuteRequest$outboundSchema.parse(multicallExecuteRequest),
+  );
+}
+
+export function multicallExecuteRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<MulticallExecuteRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MulticallExecuteRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MulticallExecuteRequest' from JSON`,
+  );
+}

package/src/models/components/pendleaddliquidityparams.ts

@@ -23,6 +23,10 @@ export type PendleAddLiquidityParams = {
    * The amount of liquidity you would like to add to the market denominated in the market's Underlying Token.
    */
   amount: number | string;
+  /**
+   * The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
+   */
+  maxSlippagePercent: number;
 };
 
 /** @internal */
@@ -86,10 +90,12 @@ export const PendleAddLiquidityParams$inboundSchema: z.ZodType<
   ),
   market_address: z.string(),
   amount: z.union([z.number(), z.string()]),
+  max_slippage_percent: z.number(),
 }).transform((v) => {
   return remap$(v, {
     "action_type": "actionType",
     "market_address": "marketAddress",
+    "max_slippage_percent": "maxSlippagePercent",
   });
 });
 
@@ -98,6 +104,7 @@ export type PendleAddLiquidityParams$Outbound = {
   action_type: "PENDLE_ADD_LIQUIDITY";
   market_address: string;
   amount: number | string;
+  max_slippage_percent: number;
 };
 
 /** @internal */
@@ -111,10 +118,12 @@ export const PendleAddLiquidityParams$outboundSchema: z.ZodType<
   ),
   marketAddress: z.string(),
   amount: z.union([z.number(), z.string()]),
+  maxSlippagePercent: z.number(),
 }).transform((v) => {
   return remap$(v, {
     actionType: "action_type",
     marketAddress: "market_address",
+    maxSlippagePercent: "max_slippage_percent",
   });
 });
 

package/src/models/components/pendleaddliquidityrequest.ts

@@ -24,6 +24,10 @@ export type PendleAddLiquidityRequest = {
    * The amount of liquidity you would like to add to the market denominated in the market's Underlying Token.
    */
   amount: number | string;
+  /**
+   * The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
+   */
+  maxSlippagePercent: number;
   /**
    * The chain to use.
    */
@@ -95,12 +99,14 @@ export const PendleAddLiquidityRequest$inboundSchema: z.ZodType<
   ),
   market_address: z.string(),
   amount: z.union([z.number(), z.string()]),
+  max_slippage_percent: z.number(),
   chain: Chain$inboundSchema,
   sender: z.string(),
 }).transform((v) => {
   return remap$(v, {
     "action_type": "actionType",
     "market_address": "marketAddress",
+    "max_slippage_percent": "maxSlippagePercent",
   });
 });
 
@@ -109,6 +115,7 @@ export type PendleAddLiquidityRequest$Outbound = {
   action_type: "PENDLE_ADD_LIQUIDITY";
   market_address: string;
   amount: number | string;
+  max_slippage_percent: number;
   chain: string;
   sender: string;
 };
@@ -124,12 +131,14 @@ export const PendleAddLiquidityRequest$outboundSchema: z.ZodType<
   ),
   marketAddress: z.string(),
   amount: z.union([z.number(), z.string()]),
+  maxSlippagePercent: z.number(),
   chain: Chain$outboundSchema,
   sender: z.string(),
 }).transform((v) => {
   return remap$(v, {
     actionType: "action_type",
     marketAddress: "market_address",
+    maxSlippagePercent: "max_slippage_percent",
   });
 });
 

package/src/models/components/pendlebuyptparams.ts

@@ -23,6 +23,10 @@ export type PendleBuyPtParams = {
    * The amount of market's Underlying Token you would like to sell for market's Principal Token (PT).
    */
   amount: number | string;
+  /**
+   * The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
+   */
+  maxSlippagePercent: number;
 };
 
 /** @internal */
@@ -82,10 +86,12 @@ export const PendleBuyPtParams$inboundSchema: z.ZodType<
   action_type: z.literal("PENDLE_BUY_PT").default("PENDLE_BUY_PT"),
   market_address: z.string(),
   amount: z.union([z.number(), z.string()]),
+  max_slippage_percent: z.number(),
 }).transform((v) => {
   return remap$(v, {
     "action_type": "actionType",
     "market_address": "marketAddress",
+    "max_slippage_percent": "maxSlippagePercent",
   });
 });
 
@@ -94,6 +100,7 @@ export type PendleBuyPtParams$Outbound = {
   action_type: "PENDLE_BUY_PT";
   market_address: string;
   amount: number | string;
+  max_slippage_percent: number;
 };
 
 /** @internal */
@@ -105,10 +112,12 @@ export const PendleBuyPtParams$outboundSchema: z.ZodType<
   actionType: z.literal("PENDLE_BUY_PT").default("PENDLE_BUY_PT" as const),
   marketAddress: z.string(),
   amount: z.union([z.number(), z.string()]),
+  maxSlippagePercent: z.number(),
 }).transform((v) => {
   return remap$(v, {
     actionType: "action_type",
     marketAddress: "market_address",
+    maxSlippagePercent: "max_slippage_percent",
   });
 });
 

package/src/models/components/pendlebuyptrequest.ts

@@ -24,6 +24,10 @@ export type PendleBuyPtRequest = {
    * The amount of market's Underlying Token you would like to sell for market's Principal Token (PT).
    */
   amount: number | string;
+  /**
+   * The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
+   */
+  maxSlippagePercent: number;
   /**
    * The chain to use.
    */
@@ -91,12 +95,14 @@ export const PendleBuyPtRequest$inboundSchema: z.ZodType<
   action_type: z.literal("PENDLE_BUY_PT").default("PENDLE_BUY_PT"),
   market_address: z.string(),
   amount: z.union([z.number(), z.string()]),
+  max_slippage_percent: z.number(),
   chain: Chain$inboundSchema,
   sender: z.string(),
 }).transform((v) => {
   return remap$(v, {
     "action_type": "actionType",
     "market_address": "marketAddress",
+    "max_slippage_percent": "maxSlippagePercent",
   });
 });
 
@@ -105,6 +111,7 @@ export type PendleBuyPtRequest$Outbound = {
   action_type: "PENDLE_BUY_PT";
   market_address: string;
   amount: number | string;
+  max_slippage_percent: number;
   chain: string;
   sender: string;
 };
@@ -118,12 +125,14 @@ export const PendleBuyPtRequest$outboundSchema: z.ZodType<
   actionType: z.literal("PENDLE_BUY_PT").default("PENDLE_BUY_PT" as const),
   marketAddress: z.string(),
   amount: z.union([z.number(), z.string()]),
+  maxSlippagePercent: z.number(),
   chain: Chain$outboundSchema,
   sender: z.string(),
 }).transform((v) => {
   return remap$(v, {
     actionType: "action_type",
     marketAddress: "market_address",
+    maxSlippagePercent: "max_slippage_percent",
   });
 });
 

package/src/models/components/pendlebuyytparams.ts

@@ -23,6 +23,10 @@ export type PendleBuyYtParams = {
    * The amount of market's Underlying Token you would like to sell for market's Yield Token (YT).
    */
   amount: number | string;
+  /**
+   * The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
+   */
+  maxSlippagePercent: number;
 };
 
 /** @internal */
@@ -82,10 +86,12 @@ export const PendleBuyYtParams$inboundSchema: z.ZodType<
   action_type: z.literal("PENDLE_BUY_YT").default("PENDLE_BUY_YT"),
   market_address: z.string(),
   amount: z.union([z.number(), z.string()]),
+  max_slippage_percent: z.number(),
 }).transform((v) => {
   return remap$(v, {
     "action_type": "actionType",
     "market_address": "marketAddress",
+    "max_slippage_percent": "maxSlippagePercent",
   });
 });
 
@@ -94,6 +100,7 @@ export type PendleBuyYtParams$Outbound = {
   action_type: "PENDLE_BUY_YT";
   market_address: string;
   amount: number | string;
+  max_slippage_percent: number;
 };
 
 /** @internal */
@@ -105,10 +112,12 @@ export const PendleBuyYtParams$outboundSchema: z.ZodType<
   actionType: z.literal("PENDLE_BUY_YT").default("PENDLE_BUY_YT" as const),
   marketAddress: z.string(),
   amount: z.union([z.number(), z.string()]),
+  maxSlippagePercent: z.number(),
 }).transform((v) => {
   return remap$(v, {
     actionType: "action_type",
     marketAddress: "market_address",
+    maxSlippagePercent: "max_slippage_percent",
   });
 });
 

package/src/models/components/pendlebuyytrequest.ts

@@ -24,6 +24,10 @@ export type PendleBuyYtRequest = {
    * The amount of market's Underlying Token you would like to sell for market's Yield Token (YT).
    */
   amount: number | string;
+  /**
+   * The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
+   */
+  maxSlippagePercent: number;
   /**
    * The chain to use.
    */
@@ -91,12 +95,14 @@ export const PendleBuyYtRequest$inboundSchema: z.ZodType<
   action_type: z.literal("PENDLE_BUY_YT").default("PENDLE_BUY_YT"),
   market_address: z.string(),
   amount: z.union([z.number(), z.string()]),
+  max_slippage_percent: z.number(),
   chain: Chain$inboundSchema,
   sender: z.string(),
 }).transform((v) => {
   return remap$(v, {
     "action_type": "actionType",
     "market_address": "marketAddress",
+    "max_slippage_percent": "maxSlippagePercent",
   });
 });
 
@@ -105,6 +111,7 @@ export type PendleBuyYtRequest$Outbound = {
   action_type: "PENDLE_BUY_YT";
   market_address: string;
   amount: number | string;
+  max_slippage_percent: number;
   chain: string;
   sender: string;
 };
@@ -118,12 +125,14 @@ export const PendleBuyYtRequest$outboundSchema: z.ZodType<
   actionType: z.literal("PENDLE_BUY_YT").default("PENDLE_BUY_YT" as const),
   marketAddress: z.string(),
   amount: z.union([z.number(), z.string()]),
+  maxSlippagePercent: z.number(),
   chain: Chain$outboundSchema,
   sender: z.string(),
 }).transform((v) => {
   return remap$(v, {
     actionType: "action_type",
     marketAddress: "market_address",
+    maxSlippagePercent: "max_slippage_percent",
   });
 });
 

package/src/models/components/pendleremoveliquidityparams.ts

@@ -23,6 +23,10 @@ export type PendleRemoveLiquidityParams = {
    * The amount of liquidity you would like to remove from the market denominated in the market's Liquidity Provider Token (LP).
    */
   amount: number | string;
+  /**
+   * The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
+   */
+  maxSlippagePercent: number;
 };
 
 /** @internal */
@@ -87,10 +91,12 @@ export const PendleRemoveLiquidityParams$inboundSchema: z.ZodType<
   ),
   market_address: z.string(),
   amount: z.union([z.number(), z.string()]),
+  max_slippage_percent: z.number(),
 }).transform((v) => {
   return remap$(v, {
     "action_type": "actionType",
     "market_address": "marketAddress",
+    "max_slippage_percent": "maxSlippagePercent",
   });
 });
 
@@ -99,6 +105,7 @@ export type PendleRemoveLiquidityParams$Outbound = {
   action_type: "PENDLE_REMOVE_LIQUIDITY";
   market_address: string;
   amount: number | string;
+  max_slippage_percent: number;
 };
 
 /** @internal */
@@ -112,10 +119,12 @@ export const PendleRemoveLiquidityParams$outboundSchema: z.ZodType<
   ),
   marketAddress: z.string(),
   amount: z.union([z.number(), z.string()]),
+  maxSlippagePercent: z.number(),
 }).transform((v) => {
   return remap$(v, {
     actionType: "action_type",
     marketAddress: "market_address",
+    maxSlippagePercent: "max_slippage_percent",
   });
 });
 

package/src/models/components/pendleremoveliquidityrequest.ts

@@ -24,6 +24,10 @@ export type PendleRemoveLiquidityRequest = {
    * The amount of liquidity you would like to remove from the market denominated in the market's Liquidity Provider Token (LP).
    */
   amount: number | string;
+  /**
+   * The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
+   */
+  maxSlippagePercent: number;
   /**
    * The chain to use.
    */
@@ -97,12 +101,14 @@ export const PendleRemoveLiquidityRequest$inboundSchema: z.ZodType<
   ),
   market_address: z.string(),
   amount: z.union([z.number(), z.string()]),
+  max_slippage_percent: z.number(),
   chain: Chain$inboundSchema,
   sender: z.string(),
 }).transform((v) => {
   return remap$(v, {
     "action_type": "actionType",
     "market_address": "marketAddress",
+    "max_slippage_percent": "maxSlippagePercent",
   });
 });
 
@@ -111,6 +117,7 @@ export type PendleRemoveLiquidityRequest$Outbound = {
   action_type: "PENDLE_REMOVE_LIQUIDITY";
   market_address: string;
   amount: number | string;
+  max_slippage_percent: number;
   chain: string;
   sender: string;
 };
@@ -126,12 +133,14 @@ export const PendleRemoveLiquidityRequest$outboundSchema: z.ZodType<
   ),
   marketAddress: z.string(),
   amount: z.union([z.number(), z.string()]),
+  maxSlippagePercent: z.number(),
   chain: Chain$outboundSchema,
   sender: z.string(),
 }).transform((v) => {
   return remap$(v, {
     actionType: "action_type",
     marketAddress: "market_address",
+    maxSlippagePercent: "max_slippage_percent",
   });
 });
 

package/src/models/components/pendlesellptparams.ts

@@ -23,6 +23,10 @@ export type PendleSellPtParams = {
    * The amount of market's Principal Token (PT) you would like to sell for market's Underlying Token.
    */
   amount: number | string;
+  /**
+   * The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
+   */
+  maxSlippagePercent: number;
 };
 
 /** @internal */
@@ -82,10 +86,12 @@ export const PendleSellPtParams$inboundSchema: z.ZodType<
   action_type: z.literal("PENDLE_SELL_PT").default("PENDLE_SELL_PT"),
   market_address: z.string(),
   amount: z.union([z.number(), z.string()]),
+  max_slippage_percent: z.number(),
 }).transform((v) => {
   return remap$(v, {
     "action_type": "actionType",
     "market_address": "marketAddress",
+    "max_slippage_percent": "maxSlippagePercent",
   });
 });
 
@@ -94,6 +100,7 @@ export type PendleSellPtParams$Outbound = {
   action_type: "PENDLE_SELL_PT";
   market_address: string;
   amount: number | string;
+  max_slippage_percent: number;
 };
 
 /** @internal */
@@ -105,10 +112,12 @@ export const PendleSellPtParams$outboundSchema: z.ZodType<
   actionType: z.literal("PENDLE_SELL_PT").default("PENDLE_SELL_PT" as const),
   marketAddress: z.string(),
   amount: z.union([z.number(), z.string()]),
+  maxSlippagePercent: z.number(),
 }).transform((v) => {
   return remap$(v, {
     actionType: "action_type",
     marketAddress: "market_address",
+    maxSlippagePercent: "max_slippage_percent",
   });
 });
 

package/src/models/components/pendlesellptrequest.ts

@@ -24,6 +24,10 @@ export type PendleSellPtRequest = {
    * The amount of market's Principal Token (PT) you would like to sell for market's Underlying Token.
    */
   amount: number | string;
+  /**
+   * The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
+   */
+  maxSlippagePercent: number;
   /**
    * The chain to use.
    */
@@ -91,12 +95,14 @@ export const PendleSellPtRequest$inboundSchema: z.ZodType<
   action_type: z.literal("PENDLE_SELL_PT").default("PENDLE_SELL_PT"),
   market_address: z.string(),
   amount: z.union([z.number(), z.string()]),
+  max_slippage_percent: z.number(),
   chain: Chain$inboundSchema,
   sender: z.string(),
 }).transform((v) => {
   return remap$(v, {
     "action_type": "actionType",
     "market_address": "marketAddress",
+    "max_slippage_percent": "maxSlippagePercent",
   });
 });
 
@@ -105,6 +111,7 @@ export type PendleSellPtRequest$Outbound = {
   action_type: "PENDLE_SELL_PT";
   market_address: string;
   amount: number | string;
+  max_slippage_percent: number;
   chain: string;
   sender: string;
 };
@@ -118,12 +125,14 @@ export const PendleSellPtRequest$outboundSchema: z.ZodType<
   actionType: z.literal("PENDLE_SELL_PT").default("PENDLE_SELL_PT" as const),
   marketAddress: z.string(),
   amount: z.union([z.number(), z.string()]),
+  maxSlippagePercent: z.number(),
   chain: Chain$outboundSchema,
   sender: z.string(),
 }).transform((v) => {
   return remap$(v, {
     actionType: "action_type",
     marketAddress: "market_address",
+    maxSlippagePercent: "max_slippage_percent",
   });
 });
 

package/src/models/components/pendlesellytparams.ts

@@ -23,6 +23,10 @@ export type PendleSellYtParams = {
    * The amount of market's Yield Token (YT) you would like to sell for market's Underlying Token.
    */
   amount: number | string;
+  /**
+   * The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
+   */
+  maxSlippagePercent: number;
 };
 
 /** @internal */
@@ -82,10 +86,12 @@ export const PendleSellYtParams$inboundSchema: z.ZodType<
   action_type: z.literal("PENDLE_SELL_YT").default("PENDLE_SELL_YT"),
   market_address: z.string(),
   amount: z.union([z.number(), z.string()]),
+  max_slippage_percent: z.number(),
 }).transform((v) => {
   return remap$(v, {
     "action_type": "actionType",
     "market_address": "marketAddress",
+    "max_slippage_percent": "maxSlippagePercent",
   });
 });
 
@@ -94,6 +100,7 @@ export type PendleSellYtParams$Outbound = {
   action_type: "PENDLE_SELL_YT";
   market_address: string;
   amount: number | string;
+  max_slippage_percent: number;
 };
 
 /** @internal */
@@ -105,10 +112,12 @@ export const PendleSellYtParams$outboundSchema: z.ZodType<
   actionType: z.literal("PENDLE_SELL_YT").default("PENDLE_SELL_YT" as const),
   marketAddress: z.string(),
   amount: z.union([z.number(), z.string()]),
+  maxSlippagePercent: z.number(),
 }).transform((v) => {
   return remap$(v, {
     actionType: "action_type",
     marketAddress: "market_address",
+    maxSlippagePercent: "max_slippage_percent",
   });
 });
 

package/src/models/components/pendlesellytrequest.ts

@@ -24,6 +24,10 @@ export type PendleSellYtRequest = {
    * The amount of market's Yield Token (YT) you would like to sell for market's Underlying Token.
    */
   amount: number | string;
+  /**
+   * The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
+   */
+  maxSlippagePercent: number;
   /**
    * The chain to use.
    */
@@ -91,12 +95,14 @@ export const PendleSellYtRequest$inboundSchema: z.ZodType<
   action_type: z.literal("PENDLE_SELL_YT").default("PENDLE_SELL_YT"),
   market_address: z.string(),
   amount: z.union([z.number(), z.string()]),
+  max_slippage_percent: z.number(),
   chain: Chain$inboundSchema,
   sender: z.string(),
 }).transform((v) => {
   return remap$(v, {
     "action_type": "actionType",
     "market_address": "marketAddress",
+    "max_slippage_percent": "maxSlippagePercent",
   });
 });
 
@@ -105,6 +111,7 @@ export type PendleSellYtRequest$Outbound = {
   action_type: "PENDLE_SELL_YT";
   market_address: string;
   amount: number | string;
+  max_slippage_percent: number;
   chain: string;
   sender: string;
 };
@@ -118,12 +125,14 @@ export const PendleSellYtRequest$outboundSchema: z.ZodType<
   actionType: z.literal("PENDLE_SELL_YT").default("PENDLE_SELL_YT" as const),
   marketAddress: z.string(),
   amount: z.union([z.number(), z.string()]),
+  maxSlippagePercent: z.number(),
   chain: Chain$outboundSchema,
   sender: z.string(),
 }).transform((v) => {
   return remap$(v, {
     actionType: "action_type",
     marketAddress: "market_address",
+    maxSlippagePercent: "max_slippage_percent",
   });
 });