@compass-labs/api-sdk 0.1.7 → 0.1.9

package/src/models/operations/uniswappoolprice.ts

@@ -22,6 +22,11 @@ export const UniswapPoolPriceChain = {
  */
 export type UniswapPoolPriceChain = ClosedEnum<typeof UniswapPoolPriceChain>;
 
+/**
+ * The block number you want to get this data at.
+ */
+export type UniswapPoolPriceBlock = number | string;
+
 /**
  * A class representing the token.
  *
@@ -183,6 +188,10 @@ export type UniswapPoolPriceRequest = {
    * The chain to use.
    */
   chain?: UniswapPoolPriceChain | undefined;
+  /**
+   * The block number you want to get this data at.
+   */
+  block?: number | string | undefined;
   /**
    * The symbol of a token in the pool
    */
@@ -218,6 +227,54 @@ export namespace UniswapPoolPriceChain$ {
   export const outboundSchema = UniswapPoolPriceChain$outboundSchema;
 }
 
+/** @internal */
+export const UniswapPoolPriceBlock$inboundSchema: z.ZodType<
+  UniswapPoolPriceBlock,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number().int(), z.string()]);
+
+/** @internal */
+export type UniswapPoolPriceBlock$Outbound = number | string;
+
+/** @internal */
+export const UniswapPoolPriceBlock$outboundSchema: z.ZodType<
+  UniswapPoolPriceBlock$Outbound,
+  z.ZodTypeDef,
+  UniswapPoolPriceBlock
+> = z.union([z.number().int(), 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 UniswapPoolPriceBlock$ {
+  /** @deprecated use `UniswapPoolPriceBlock$inboundSchema` instead. */
+  export const inboundSchema = UniswapPoolPriceBlock$inboundSchema;
+  /** @deprecated use `UniswapPoolPriceBlock$outboundSchema` instead. */
+  export const outboundSchema = UniswapPoolPriceBlock$outboundSchema;
+  /** @deprecated use `UniswapPoolPriceBlock$Outbound` instead. */
+  export type Outbound = UniswapPoolPriceBlock$Outbound;
+}
+
+export function uniswapPoolPriceBlockToJSON(
+  uniswapPoolPriceBlock: UniswapPoolPriceBlock,
+): string {
+  return JSON.stringify(
+    UniswapPoolPriceBlock$outboundSchema.parse(uniswapPoolPriceBlock),
+  );
+}
+
+export function uniswapPoolPriceBlockFromJSON(
+  jsonString: string,
+): SafeParseResult<UniswapPoolPriceBlock, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UniswapPoolPriceBlock$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UniswapPoolPriceBlock' from JSON`,
+  );
+}
+
 /** @internal */
 export const UniswapPoolPriceTokenInToken$inboundSchema: z.ZodNativeEnum<
   typeof UniswapPoolPriceTokenInToken
@@ -288,6 +345,7 @@ export const UniswapPoolPriceRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   chain: UniswapPoolPriceChain$inboundSchema.default("arbitrum:mainnet"),
+  block: z.union([z.number().int(), z.string()]).optional(),
   token_in: UniswapPoolPriceTokenInToken$inboundSchema.default("USDC"),
   token_out: UniswapPoolPriceTokenOutToken$inboundSchema.default("USDT"),
   fee: UniswapPoolPriceFeeEnum$inboundSchema.default("0.01"),
@@ -301,6 +359,7 @@ export const UniswapPoolPriceRequest$inboundSchema: z.ZodType<
 /** @internal */
 export type UniswapPoolPriceRequest$Outbound = {
   chain: string;
+  block?: number | string | undefined;
   token_in: string;
   token_out: string;
   fee: string;
@@ -313,6 +372,7 @@ export const UniswapPoolPriceRequest$outboundSchema: z.ZodType<
   UniswapPoolPriceRequest
 > = z.object({
   chain: UniswapPoolPriceChain$outboundSchema.default("arbitrum:mainnet"),
+  block: z.union([z.number().int(), z.string()]).optional(),
   tokenIn: UniswapPoolPriceTokenInToken$outboundSchema.default("USDC"),
   tokenOut: UniswapPoolPriceTokenOutToken$outboundSchema.default("USDT"),
   fee: UniswapPoolPriceFeeEnum$outboundSchema.default("0.01"),

package/src/models/operations/uniswapquotebuyexactly.ts

@@ -24,6 +24,11 @@ export type UniswapQuoteBuyExactlyChain = ClosedEnum<
   typeof UniswapQuoteBuyExactlyChain
 >;
 
+/**
+ * The block number you want to get this data at.
+ */
+export type UniswapQuoteBuyExactlyBlock = number | string;
+
 /**
  * A class representing the token.
  *
@@ -190,6 +195,10 @@ export type UniswapQuoteBuyExactlyRequest = {
    * The chain to use.
    */
   chain?: UniswapQuoteBuyExactlyChain | undefined;
+  /**
+   * The block number you want to get this data at.
+   */
+  block?: number | string | undefined;
   /**
    * The symbol of the token to swap from.
    */
@@ -229,6 +238,56 @@ export namespace UniswapQuoteBuyExactlyChain$ {
   export const outboundSchema = UniswapQuoteBuyExactlyChain$outboundSchema;
 }
 
+/** @internal */
+export const UniswapQuoteBuyExactlyBlock$inboundSchema: z.ZodType<
+  UniswapQuoteBuyExactlyBlock,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number().int(), z.string()]);
+
+/** @internal */
+export type UniswapQuoteBuyExactlyBlock$Outbound = number | string;
+
+/** @internal */
+export const UniswapQuoteBuyExactlyBlock$outboundSchema: z.ZodType<
+  UniswapQuoteBuyExactlyBlock$Outbound,
+  z.ZodTypeDef,
+  UniswapQuoteBuyExactlyBlock
+> = z.union([z.number().int(), 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 UniswapQuoteBuyExactlyBlock$ {
+  /** @deprecated use `UniswapQuoteBuyExactlyBlock$inboundSchema` instead. */
+  export const inboundSchema = UniswapQuoteBuyExactlyBlock$inboundSchema;
+  /** @deprecated use `UniswapQuoteBuyExactlyBlock$outboundSchema` instead. */
+  export const outboundSchema = UniswapQuoteBuyExactlyBlock$outboundSchema;
+  /** @deprecated use `UniswapQuoteBuyExactlyBlock$Outbound` instead. */
+  export type Outbound = UniswapQuoteBuyExactlyBlock$Outbound;
+}
+
+export function uniswapQuoteBuyExactlyBlockToJSON(
+  uniswapQuoteBuyExactlyBlock: UniswapQuoteBuyExactlyBlock,
+): string {
+  return JSON.stringify(
+    UniswapQuoteBuyExactlyBlock$outboundSchema.parse(
+      uniswapQuoteBuyExactlyBlock,
+    ),
+  );
+}
+
+export function uniswapQuoteBuyExactlyBlockFromJSON(
+  jsonString: string,
+): SafeParseResult<UniswapQuoteBuyExactlyBlock, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UniswapQuoteBuyExactlyBlock$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UniswapQuoteBuyExactlyBlock' from JSON`,
+  );
+}
+
 /** @internal */
 export const UniswapQuoteBuyExactlyTokenInToken$inboundSchema: z.ZodNativeEnum<
   typeof UniswapQuoteBuyExactlyTokenInToken
@@ -346,6 +405,7 @@ export const UniswapQuoteBuyExactlyRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   chain: UniswapQuoteBuyExactlyChain$inboundSchema.default("arbitrum:mainnet"),
+  block: z.union([z.number().int(), z.string()]).optional(),
   token_in: UniswapQuoteBuyExactlyTokenInToken$inboundSchema.default("USDC"),
   token_out: UniswapQuoteBuyExactlyTokenOutToken$inboundSchema.default("USDT"),
   fee: UniswapQuoteBuyExactlyFeeEnum$inboundSchema.default("0.01"),
@@ -361,6 +421,7 @@ export const UniswapQuoteBuyExactlyRequest$inboundSchema: z.ZodType<
 /** @internal */
 export type UniswapQuoteBuyExactlyRequest$Outbound = {
   chain: string;
+  block?: number | string | undefined;
   token_in: string;
   token_out: string;
   fee: string;
@@ -374,6 +435,7 @@ export const UniswapQuoteBuyExactlyRequest$outboundSchema: z.ZodType<
   UniswapQuoteBuyExactlyRequest
 > = z.object({
   chain: UniswapQuoteBuyExactlyChain$outboundSchema.default("arbitrum:mainnet"),
+  block: z.union([z.number().int(), z.string()]).optional(),
   tokenIn: UniswapQuoteBuyExactlyTokenInToken$outboundSchema.default("USDC"),
   tokenOut: UniswapQuoteBuyExactlyTokenOutToken$outboundSchema.default("USDT"),
   fee: UniswapQuoteBuyExactlyFeeEnum$outboundSchema.default("0.01"),

package/src/models/operations/uniswapquotesellexactly.ts

@@ -24,6 +24,11 @@ export type UniswapQuoteSellExactlyChain = ClosedEnum<
   typeof UniswapQuoteSellExactlyChain
 >;
 
+/**
+ * The block number you want to get this data at.
+ */
+export type UniswapQuoteSellExactlyBlock = number | string;
+
 /**
  * A class representing the token.
  *
@@ -190,6 +195,10 @@ export type UniswapQuoteSellExactlyRequest = {
    * The chain to use.
    */
   chain?: UniswapQuoteSellExactlyChain | undefined;
+  /**
+   * The block number you want to get this data at.
+   */
+  block?: number | string | undefined;
   /**
    * The symbol of the token to swap from.
    */
@@ -229,6 +238,56 @@ export namespace UniswapQuoteSellExactlyChain$ {
   export const outboundSchema = UniswapQuoteSellExactlyChain$outboundSchema;
 }
 
+/** @internal */
+export const UniswapQuoteSellExactlyBlock$inboundSchema: z.ZodType<
+  UniswapQuoteSellExactlyBlock,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number().int(), z.string()]);
+
+/** @internal */
+export type UniswapQuoteSellExactlyBlock$Outbound = number | string;
+
+/** @internal */
+export const UniswapQuoteSellExactlyBlock$outboundSchema: z.ZodType<
+  UniswapQuoteSellExactlyBlock$Outbound,
+  z.ZodTypeDef,
+  UniswapQuoteSellExactlyBlock
+> = z.union([z.number().int(), 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 UniswapQuoteSellExactlyBlock$ {
+  /** @deprecated use `UniswapQuoteSellExactlyBlock$inboundSchema` instead. */
+  export const inboundSchema = UniswapQuoteSellExactlyBlock$inboundSchema;
+  /** @deprecated use `UniswapQuoteSellExactlyBlock$outboundSchema` instead. */
+  export const outboundSchema = UniswapQuoteSellExactlyBlock$outboundSchema;
+  /** @deprecated use `UniswapQuoteSellExactlyBlock$Outbound` instead. */
+  export type Outbound = UniswapQuoteSellExactlyBlock$Outbound;
+}
+
+export function uniswapQuoteSellExactlyBlockToJSON(
+  uniswapQuoteSellExactlyBlock: UniswapQuoteSellExactlyBlock,
+): string {
+  return JSON.stringify(
+    UniswapQuoteSellExactlyBlock$outboundSchema.parse(
+      uniswapQuoteSellExactlyBlock,
+    ),
+  );
+}
+
+export function uniswapQuoteSellExactlyBlockFromJSON(
+  jsonString: string,
+): SafeParseResult<UniswapQuoteSellExactlyBlock, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UniswapQuoteSellExactlyBlock$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UniswapQuoteSellExactlyBlock' from JSON`,
+  );
+}
+
 /** @internal */
 export const UniswapQuoteSellExactlyTokenInToken$inboundSchema: z.ZodNativeEnum<
   typeof UniswapQuoteSellExactlyTokenInToken
@@ -348,6 +407,7 @@ export const UniswapQuoteSellExactlyRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   chain: UniswapQuoteSellExactlyChain$inboundSchema.default("arbitrum:mainnet"),
+  block: z.union([z.number().int(), z.string()]).optional(),
   token_in: UniswapQuoteSellExactlyTokenInToken$inboundSchema.default("USDC"),
   token_out: UniswapQuoteSellExactlyTokenOutToken$inboundSchema.default("USDT"),
   fee: UniswapQuoteSellExactlyFeeEnum$inboundSchema.default("0.01"),
@@ -363,6 +423,7 @@ export const UniswapQuoteSellExactlyRequest$inboundSchema: z.ZodType<
 /** @internal */
 export type UniswapQuoteSellExactlyRequest$Outbound = {
   chain: string;
+  block?: number | string | undefined;
   token_in: string;
   token_out: string;
   fee: string;
@@ -378,6 +439,7 @@ export const UniswapQuoteSellExactlyRequest$outboundSchema: z.ZodType<
   chain: UniswapQuoteSellExactlyChain$outboundSchema.default(
     "arbitrum:mainnet",
   ),
+  block: z.union([z.number().int(), z.string()]).optional(),
   tokenIn: UniswapQuoteSellExactlyTokenInToken$outboundSchema.default("USDC"),
   tokenOut: UniswapQuoteSellExactlyTokenOutToken$outboundSchema.default("USDT"),
   fee: UniswapQuoteSellExactlyFeeEnum$outboundSchema.default("0.01"),

package/src/sdk/pendle.ts

@@ -14,7 +14,7 @@ export class Pendle extends ClientSDK {
    * Check User's Market Position
    *
    * @remarks
-   * Check the SY, PT, and YT positions for a given market.
+   * Check the SY, PT, YT and Underlying Token positions for a given market.
    */
   async position(
     request: operations.PendlePositionRequest,
@@ -31,7 +31,7 @@ export class Pendle extends ClientSDK {
    * Get Market Data
    *
    * @remarks
-   * Get market data.
+   * Get the market's implied APY, maturity date and the associated token data.
    */
   async market(
     request: operations.PendleMarketRequest,