@compass-labs/api-sdk 0.5.13 → 0.5.15

package/src/models/components/aavelooprequest.ts

@@ -0,0 +1,368 @@
+/*
+ * 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 {
+  TokenEnum,
+  TokenEnum$inboundSchema,
+  TokenEnum$outboundSchema,
+} from "./tokenenum.js";
+
+/**
+ * Amount of collateral token to supply to Aave
+ */
+export type InitialCollateralAmount = number | string;
+
+/**
+ * Total loop collateral will be calculated as `multiplier` x `initial_collateral_amount`
+ */
+export type Multiplier = number | string;
+
+/**
+ * Maximum allowed slippage for token swaps in percentage
+ */
+export type MaxSlippagePercent = number | string;
+
+/**
+ * Loan To Value percentage of the loop
+ */
+export type LoanToValue = number | string;
+
+/**
+ * Request model for executing an Aave loop strategy.
+ */
+export type AaveLoopRequest = {
+  /**
+   * The chain to use.
+   */
+  chain: Chain;
+  /**
+   * The address of the transaction sender.
+   */
+  sender: string;
+  signedAuthorization: SignedAuthorization;
+  /**
+   * A class representing the token.
+   *
+   * @remarks
+   *
+   * This class is used to represent the token in the system. Notice individual
+   * endpoints' documentation where per chain tokens are presented.
+   */
+  collateralToken: TokenEnum;
+  /**
+   * A class representing the token.
+   *
+   * @remarks
+   *
+   * This class is used to represent the token in the system. Notice individual
+   * endpoints' documentation where per chain tokens are presented.
+   */
+  borrowToken: TokenEnum;
+  /**
+   * Amount of collateral token to supply to Aave
+   */
+  initialCollateralAmount: number | string;
+  /**
+   * Total loop collateral will be calculated as `multiplier` x `initial_collateral_amount`
+   */
+  multiplier: number | string;
+  /**
+   * Maximum allowed slippage for token swaps in percentage
+   */
+  maxSlippagePercent: number | string;
+  /**
+   * Loan To Value percentage of the loop
+   */
+  loanToValue: number | string;
+};
+
+/** @internal */
+export const InitialCollateralAmount$inboundSchema: z.ZodType<
+  InitialCollateralAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type InitialCollateralAmount$Outbound = number | string;
+
+/** @internal */
+export const InitialCollateralAmount$outboundSchema: z.ZodType<
+  InitialCollateralAmount$Outbound,
+  z.ZodTypeDef,
+  InitialCollateralAmount
+> = 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 InitialCollateralAmount$ {
+  /** @deprecated use `InitialCollateralAmount$inboundSchema` instead. */
+  export const inboundSchema = InitialCollateralAmount$inboundSchema;
+  /** @deprecated use `InitialCollateralAmount$outboundSchema` instead. */
+  export const outboundSchema = InitialCollateralAmount$outboundSchema;
+  /** @deprecated use `InitialCollateralAmount$Outbound` instead. */
+  export type Outbound = InitialCollateralAmount$Outbound;
+}
+
+export function initialCollateralAmountToJSON(
+  initialCollateralAmount: InitialCollateralAmount,
+): string {
+  return JSON.stringify(
+    InitialCollateralAmount$outboundSchema.parse(initialCollateralAmount),
+  );
+}
+
+export function initialCollateralAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<InitialCollateralAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InitialCollateralAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InitialCollateralAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const Multiplier$inboundSchema: z.ZodType<
+  Multiplier,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type Multiplier$Outbound = number | string;
+
+/** @internal */
+export const Multiplier$outboundSchema: z.ZodType<
+  Multiplier$Outbound,
+  z.ZodTypeDef,
+  Multiplier
+> = 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 Multiplier$ {
+  /** @deprecated use `Multiplier$inboundSchema` instead. */
+  export const inboundSchema = Multiplier$inboundSchema;
+  /** @deprecated use `Multiplier$outboundSchema` instead. */
+  export const outboundSchema = Multiplier$outboundSchema;
+  /** @deprecated use `Multiplier$Outbound` instead. */
+  export type Outbound = Multiplier$Outbound;
+}
+
+export function multiplierToJSON(multiplier: Multiplier): string {
+  return JSON.stringify(Multiplier$outboundSchema.parse(multiplier));
+}
+
+export function multiplierFromJSON(
+  jsonString: string,
+): SafeParseResult<Multiplier, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Multiplier$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Multiplier' from JSON`,
+  );
+}
+
+/** @internal */
+export const MaxSlippagePercent$inboundSchema: z.ZodType<
+  MaxSlippagePercent,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type MaxSlippagePercent$Outbound = number | string;
+
+/** @internal */
+export const MaxSlippagePercent$outboundSchema: z.ZodType<
+  MaxSlippagePercent$Outbound,
+  z.ZodTypeDef,
+  MaxSlippagePercent
+> = 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 MaxSlippagePercent$ {
+  /** @deprecated use `MaxSlippagePercent$inboundSchema` instead. */
+  export const inboundSchema = MaxSlippagePercent$inboundSchema;
+  /** @deprecated use `MaxSlippagePercent$outboundSchema` instead. */
+  export const outboundSchema = MaxSlippagePercent$outboundSchema;
+  /** @deprecated use `MaxSlippagePercent$Outbound` instead. */
+  export type Outbound = MaxSlippagePercent$Outbound;
+}
+
+export function maxSlippagePercentToJSON(
+  maxSlippagePercent: MaxSlippagePercent,
+): string {
+  return JSON.stringify(
+    MaxSlippagePercent$outboundSchema.parse(maxSlippagePercent),
+  );
+}
+
+export function maxSlippagePercentFromJSON(
+  jsonString: string,
+): SafeParseResult<MaxSlippagePercent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MaxSlippagePercent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MaxSlippagePercent' from JSON`,
+  );
+}
+
+/** @internal */
+export const LoanToValue$inboundSchema: z.ZodType<
+  LoanToValue,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type LoanToValue$Outbound = number | string;
+
+/** @internal */
+export const LoanToValue$outboundSchema: z.ZodType<
+  LoanToValue$Outbound,
+  z.ZodTypeDef,
+  LoanToValue
+> = 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 LoanToValue$ {
+  /** @deprecated use `LoanToValue$inboundSchema` instead. */
+  export const inboundSchema = LoanToValue$inboundSchema;
+  /** @deprecated use `LoanToValue$outboundSchema` instead. */
+  export const outboundSchema = LoanToValue$outboundSchema;
+  /** @deprecated use `LoanToValue$Outbound` instead. */
+  export type Outbound = LoanToValue$Outbound;
+}
+
+export function loanToValueToJSON(loanToValue: LoanToValue): string {
+  return JSON.stringify(LoanToValue$outboundSchema.parse(loanToValue));
+}
+
+export function loanToValueFromJSON(
+  jsonString: string,
+): SafeParseResult<LoanToValue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LoanToValue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LoanToValue' from JSON`,
+  );
+}
+
+/** @internal */
+export const AaveLoopRequest$inboundSchema: z.ZodType<
+  AaveLoopRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chain: Chain$inboundSchema,
+  sender: z.string(),
+  signed_authorization: SignedAuthorization$inboundSchema,
+  collateral_token: TokenEnum$inboundSchema,
+  borrow_token: TokenEnum$inboundSchema,
+  initial_collateral_amount: z.union([z.number(), z.string()]),
+  multiplier: z.union([z.number(), z.string()]),
+  max_slippage_percent: z.union([z.number(), z.string()]),
+  loan_to_value: z.union([z.number(), z.string()]),
+}).transform((v) => {
+  return remap$(v, {
+    "signed_authorization": "signedAuthorization",
+    "collateral_token": "collateralToken",
+    "borrow_token": "borrowToken",
+    "initial_collateral_amount": "initialCollateralAmount",
+    "max_slippage_percent": "maxSlippagePercent",
+    "loan_to_value": "loanToValue",
+  });
+});
+
+/** @internal */
+export type AaveLoopRequest$Outbound = {
+  chain: string;
+  sender: string;
+  signed_authorization: SignedAuthorization$Outbound;
+  collateral_token: string;
+  borrow_token: string;
+  initial_collateral_amount: number | string;
+  multiplier: number | string;
+  max_slippage_percent: number | string;
+  loan_to_value: number | string;
+};
+
+/** @internal */
+export const AaveLoopRequest$outboundSchema: z.ZodType<
+  AaveLoopRequest$Outbound,
+  z.ZodTypeDef,
+  AaveLoopRequest
+> = z.object({
+  chain: Chain$outboundSchema,
+  sender: z.string(),
+  signedAuthorization: SignedAuthorization$outboundSchema,
+  collateralToken: TokenEnum$outboundSchema,
+  borrowToken: TokenEnum$outboundSchema,
+  initialCollateralAmount: z.union([z.number(), z.string()]),
+  multiplier: z.union([z.number(), z.string()]),
+  maxSlippagePercent: z.union([z.number(), z.string()]),
+  loanToValue: z.union([z.number(), z.string()]),
+}).transform((v) => {
+  return remap$(v, {
+    signedAuthorization: "signed_authorization",
+    collateralToken: "collateral_token",
+    borrowToken: "borrow_token",
+    initialCollateralAmount: "initial_collateral_amount",
+    maxSlippagePercent: "max_slippage_percent",
+    loanToValue: "loan_to_value",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveLoopRequest$ {
+  /** @deprecated use `AaveLoopRequest$inboundSchema` instead. */
+  export const inboundSchema = AaveLoopRequest$inboundSchema;
+  /** @deprecated use `AaveLoopRequest$outboundSchema` instead. */
+  export const outboundSchema = AaveLoopRequest$outboundSchema;
+  /** @deprecated use `AaveLoopRequest$Outbound` instead. */
+  export type Outbound = AaveLoopRequest$Outbound;
+}
+
+export function aaveLoopRequestToJSON(
+  aaveLoopRequest: AaveLoopRequest,
+): string {
+  return JSON.stringify(AaveLoopRequest$outboundSchema.parse(aaveLoopRequest));
+}
+
+export function aaveLoopRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveLoopRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveLoopRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveLoopRequest' from JSON`,
+  );
+}

package/src/models/components/compassapibackendmodelsmorphoreadresponsegetmarketmarketstate.ts

@@ -9,14 +9,14 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type CompassApiBackendModelsMorphoReadResponseGetMarketMarketState = {
   utilization: string;
-  collateralAssets: string;
+  collateralAssets?: string | null | undefined;
   collateralAssetsUsd?: string | null | undefined;
   borrowAssets: string;
-  borrowAssetsUsd: string;
+  borrowAssetsUsd?: string | null | undefined;
   liquidityAssets: string;
-  liquidityAssetsUsd: string;
+  liquidityAssetsUsd?: string | null | undefined;
   totalLiquidity: string;
-  totalLiquidityUsd: string;
+  totalLiquidityUsd?: string | null | undefined;
 };
 
 /** @internal */
@@ -27,28 +27,28 @@ export const CompassApiBackendModelsMorphoReadResponseGetMarketMarketState$inbou
     unknown
   > = z.object({
     utilization: z.string(),
-    collateralAssets: z.string(),
+    collateralAssets: z.nullable(z.string()).optional(),
     collateralAssetsUsd: z.nullable(z.string()).optional(),
     borrowAssets: z.string(),
-    borrowAssetsUsd: z.string(),
+    borrowAssetsUsd: z.nullable(z.string()).optional(),
     liquidityAssets: z.string(),
-    liquidityAssetsUsd: z.string(),
+    liquidityAssetsUsd: z.nullable(z.string()).optional(),
     totalLiquidity: z.string(),
-    totalLiquidityUsd: z.string(),
+    totalLiquidityUsd: z.nullable(z.string()).optional(),
   });
 
 /** @internal */
 export type CompassApiBackendModelsMorphoReadResponseGetMarketMarketState$Outbound =
   {
     utilization: string;
-    collateralAssets: string;
+    collateralAssets?: string | null | undefined;
     collateralAssetsUsd?: string | null | undefined;
     borrowAssets: string;
-    borrowAssetsUsd: string;
+    borrowAssetsUsd?: string | null | undefined;
     liquidityAssets: string;
-    liquidityAssetsUsd: string;
+    liquidityAssetsUsd?: string | null | undefined;
     totalLiquidity: string;
-    totalLiquidityUsd: string;
+    totalLiquidityUsd?: string | null | undefined;
   };
 
 /** @internal */
@@ -59,14 +59,14 @@ export const CompassApiBackendModelsMorphoReadResponseGetMarketMarketState$outbo
     CompassApiBackendModelsMorphoReadResponseGetMarketMarketState
   > = z.object({
     utilization: z.string(),
-    collateralAssets: z.string(),
+    collateralAssets: z.nullable(z.string()).optional(),
     collateralAssetsUsd: z.nullable(z.string()).optional(),
     borrowAssets: z.string(),
-    borrowAssetsUsd: z.string(),
+    borrowAssetsUsd: z.nullable(z.string()).optional(),
     liquidityAssets: z.string(),
-    liquidityAssetsUsd: z.string(),
+    liquidityAssetsUsd: z.nullable(z.string()).optional(),
     totalLiquidity: z.string(),
-    totalLiquidityUsd: z.string(),
+    totalLiquidityUsd: z.nullable(z.string()).optional(),
   });
 
 /**

package/src/models/components/index.ts

@@ -7,6 +7,7 @@ export * from "./aaveborrowparams.js";
 export * from "./aaveborrowrequest.js";
 export * from "./aavehistoricaltransactionsresponse.js";
 export * from "./aaveliquiditychangeresponse.js";
+export * from "./aavelooprequest.js";
 export * from "./aaverateresponse.js";
 export * from "./aaverepayparams.js";
 export * from "./aaverepayrequest.js";
@@ -92,6 +93,9 @@ export * from "./morphowithdrawcollateralrequest.js";
 export * from "./morphowithdrawparams.js";
 export * from "./morphowithdrawrequest.js";
 export * from "./movement10percent.js";
+export * from "./multicallauthorizationrequest.js";
+export * from "./multicallauthorizationresponse.js";
+export * from "./multicallexecuterequest.js";
 export * from "./openposition.js";
 export * from "./pendleaddliquidityparams.js";
 export * from "./pendleaddliquidityrequest.js";

package/src/models/components/metadata.ts

@@ -14,8 +14,6 @@ import {
 } from "./curator.js";
 
 export type Metadata = {
-  description: string | null;
-  image: string | null;
   forumLink: string | null;
   curators: Array<Curator>;
 };
@@ -26,16 +24,12 @@ export const Metadata$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  description: z.nullable(z.string()),
-  image: z.nullable(z.string()),
   forumLink: z.nullable(z.string()),
   curators: z.array(Curator$inboundSchema),
 });
 
 /** @internal */
 export type Metadata$Outbound = {
-  description: string | null;
-  image: string | null;
   forumLink: string | null;
   curators: Array<Curator$Outbound>;
 };
@@ -46,8 +40,6 @@ export const Metadata$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Metadata
 > = z.object({
-  description: z.nullable(z.string()),
-  image: z.nullable(z.string()),
   forumLink: z.nullable(z.string()),
   curators: z.array(Curator$outboundSchema),
 });

package/src/models/components/multicallauthorizationrequest.ts

@@ -0,0 +1,90 @@
+/*
+ * 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";
+import { Chain, Chain$inboundSchema, Chain$outboundSchema } from "./chain.js";
+
+/**
+ * Request model for getting a multicall authorization.
+ *
+ * @remarks
+ *
+ * This model is used to authorize a sender address to perform multicall operations,
+ * allowing it to call multiple functions on multiple contracts in a single
+ * transaction.
+ *
+ * Only needs to be done once per an EOA.
+ */
+export type MulticallAuthorizationRequest = {
+  /**
+   * The chain to use.
+   */
+  chain: Chain;
+  /**
+   * The Ethereum address to use for authorization
+   */
+  sender: string;
+};
+
+/** @internal */
+export const MulticallAuthorizationRequest$inboundSchema: z.ZodType<
+  MulticallAuthorizationRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chain: Chain$inboundSchema,
+  sender: z.string(),
+});
+
+/** @internal */
+export type MulticallAuthorizationRequest$Outbound = {
+  chain: string;
+  sender: string;
+};
+
+/** @internal */
+export const MulticallAuthorizationRequest$outboundSchema: z.ZodType<
+  MulticallAuthorizationRequest$Outbound,
+  z.ZodTypeDef,
+  MulticallAuthorizationRequest
+> = z.object({
+  chain: Chain$outboundSchema,
+  sender: 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 MulticallAuthorizationRequest$ {
+  /** @deprecated use `MulticallAuthorizationRequest$inboundSchema` instead. */
+  export const inboundSchema = MulticallAuthorizationRequest$inboundSchema;
+  /** @deprecated use `MulticallAuthorizationRequest$outboundSchema` instead. */
+  export const outboundSchema = MulticallAuthorizationRequest$outboundSchema;
+  /** @deprecated use `MulticallAuthorizationRequest$Outbound` instead. */
+  export type Outbound = MulticallAuthorizationRequest$Outbound;
+}
+
+export function multicallAuthorizationRequestToJSON(
+  multicallAuthorizationRequest: MulticallAuthorizationRequest,
+): string {
+  return JSON.stringify(
+    MulticallAuthorizationRequest$outboundSchema.parse(
+      multicallAuthorizationRequest,
+    ),
+  );
+}
+
+export function multicallAuthorizationRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<MulticallAuthorizationRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MulticallAuthorizationRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MulticallAuthorizationRequest' from JSON`,
+  );
+}

package/src/models/components/multicallauthorizationresponse.ts

@@ -0,0 +1,88 @@
+/*
+ * 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";
+
+/**
+ * Response model for multicall authorization.
+ */
+export type MulticallAuthorizationResponse = {
+  /**
+   * A unique nonce value for this authorization
+   */
+  nonce: number;
+  /**
+   * The Ethereum address authorized for multicall
+   */
+  address: string;
+  /**
+   * The chain ID for the blockchain network
+   */
+  chainId: number;
+};
+
+/** @internal */
+export const MulticallAuthorizationResponse$inboundSchema: z.ZodType<
+  MulticallAuthorizationResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  nonce: z.number().int(),
+  address: z.string(),
+  chainId: z.number().int(),
+});
+
+/** @internal */
+export type MulticallAuthorizationResponse$Outbound = {
+  nonce: number;
+  address: string;
+  chainId: number;
+};
+
+/** @internal */
+export const MulticallAuthorizationResponse$outboundSchema: z.ZodType<
+  MulticallAuthorizationResponse$Outbound,
+  z.ZodTypeDef,
+  MulticallAuthorizationResponse
+> = z.object({
+  nonce: z.number().int(),
+  address: z.string(),
+  chainId: z.number().int(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MulticallAuthorizationResponse$ {
+  /** @deprecated use `MulticallAuthorizationResponse$inboundSchema` instead. */
+  export const inboundSchema = MulticallAuthorizationResponse$inboundSchema;
+  /** @deprecated use `MulticallAuthorizationResponse$outboundSchema` instead. */
+  export const outboundSchema = MulticallAuthorizationResponse$outboundSchema;
+  /** @deprecated use `MulticallAuthorizationResponse$Outbound` instead. */
+  export type Outbound = MulticallAuthorizationResponse$Outbound;
+}
+
+export function multicallAuthorizationResponseToJSON(
+  multicallAuthorizationResponse: MulticallAuthorizationResponse,
+): string {
+  return JSON.stringify(
+    MulticallAuthorizationResponse$outboundSchema.parse(
+      multicallAuthorizationResponse,
+    ),
+  );
+}
+
+export function multicallAuthorizationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<MulticallAuthorizationResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MulticallAuthorizationResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MulticallAuthorizationResponse' from JSON`,
+  );
+}