@compass-labs/api-sdk 0.0.16 → 0.0.18

package/src/models/components/aavehistoricaltransactionsresponse.ts

@@ -0,0 +1,91 @@
+/*
+ * 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 {
+  AaveHistoricalTransactionBase,
+  AaveHistoricalTransactionBase$inboundSchema,
+  AaveHistoricalTransactionBase$Outbound,
+  AaveHistoricalTransactionBase$outboundSchema,
+} from "./aavehistoricaltransactionbase.js";
+
+/**
+ * Response model for getting Aave historical transactions.
+ */
+export type AaveHistoricalTransactionsResponse = {
+  total: number;
+  offset: number;
+  limit: number;
+  transactions: Array<AaveHistoricalTransactionBase>;
+};
+
+/** @internal */
+export const AaveHistoricalTransactionsResponse$inboundSchema: z.ZodType<
+  AaveHistoricalTransactionsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total: z.number().int(),
+  offset: z.number().int(),
+  limit: z.number().int(),
+  transactions: z.array(AaveHistoricalTransactionBase$inboundSchema),
+});
+
+/** @internal */
+export type AaveHistoricalTransactionsResponse$Outbound = {
+  total: number;
+  offset: number;
+  limit: number;
+  transactions: Array<AaveHistoricalTransactionBase$Outbound>;
+};
+
+/** @internal */
+export const AaveHistoricalTransactionsResponse$outboundSchema: z.ZodType<
+  AaveHistoricalTransactionsResponse$Outbound,
+  z.ZodTypeDef,
+  AaveHistoricalTransactionsResponse
+> = z.object({
+  total: z.number().int(),
+  offset: z.number().int(),
+  limit: z.number().int(),
+  transactions: z.array(AaveHistoricalTransactionBase$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveHistoricalTransactionsResponse$ {
+  /** @deprecated use `AaveHistoricalTransactionsResponse$inboundSchema` instead. */
+  export const inboundSchema = AaveHistoricalTransactionsResponse$inboundSchema;
+  /** @deprecated use `AaveHistoricalTransactionsResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    AaveHistoricalTransactionsResponse$outboundSchema;
+  /** @deprecated use `AaveHistoricalTransactionsResponse$Outbound` instead. */
+  export type Outbound = AaveHistoricalTransactionsResponse$Outbound;
+}
+
+export function aaveHistoricalTransactionsResponseToJSON(
+  aaveHistoricalTransactionsResponse: AaveHistoricalTransactionsResponse,
+): string {
+  return JSON.stringify(
+    AaveHistoricalTransactionsResponse$outboundSchema.parse(
+      aaveHistoricalTransactionsResponse,
+    ),
+  );
+}
+
+export function aaveHistoricalTransactionsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveHistoricalTransactionsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      AaveHistoricalTransactionsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveHistoricalTransactionsResponse' from JSON`,
+  );
+}

package/src/models/components/action.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const Action = {
+  Supply: "supply",
+  RedeemUnderlying: "redeemUnderlying",
+  Borrow: "borrow",
+  UsageAsCollateral: "usageAsCollateral",
+  Repay: "repay",
+  SwapBorrowRate: "swapBorrowRate",
+  LiquidationCall: "liquidationCall",
+} as const;
+export type Action = ClosedEnum<typeof Action>;
+
+/** @internal */
+export const Action$inboundSchema: z.ZodNativeEnum<typeof Action> = z
+  .nativeEnum(Action);
+
+/** @internal */
+export const Action$outboundSchema: z.ZodNativeEnum<typeof Action> =
+  Action$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Action$ {
+  /** @deprecated use `Action$inboundSchema` instead. */
+  export const inboundSchema = Action$inboundSchema;
+  /** @deprecated use `Action$outboundSchema` instead. */
+  export const outboundSchema = Action$outboundSchema;
+}

package/src/models/components/borrow.ts

@@ -0,0 +1,89 @@
+/*
+ * 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 {
+  Reserve,
+  Reserve$inboundSchema,
+  Reserve$Outbound,
+  Reserve$outboundSchema,
+} from "./reserve.js";
+
+export type Borrow = {
+  amount: string;
+  borrowRateMode: string;
+  borrowRate: string;
+  stableTokenDebt: string;
+  variableTokenDebt: string;
+  reserve: Reserve;
+  assetPriceUSD: string;
+};
+
+/** @internal */
+export const Borrow$inboundSchema: z.ZodType<Borrow, z.ZodTypeDef, unknown> = z
+  .object({
+    amount: z.string(),
+    borrowRateMode: z.string(),
+    borrowRate: z.string(),
+    stableTokenDebt: z.string(),
+    variableTokenDebt: z.string(),
+    reserve: Reserve$inboundSchema,
+    assetPriceUSD: z.string(),
+  });
+
+/** @internal */
+export type Borrow$Outbound = {
+  amount: string;
+  borrowRateMode: string;
+  borrowRate: string;
+  stableTokenDebt: string;
+  variableTokenDebt: string;
+  reserve: Reserve$Outbound;
+  assetPriceUSD: string;
+};
+
+/** @internal */
+export const Borrow$outboundSchema: z.ZodType<
+  Borrow$Outbound,
+  z.ZodTypeDef,
+  Borrow
+> = z.object({
+  amount: z.string(),
+  borrowRateMode: z.string(),
+  borrowRate: z.string(),
+  stableTokenDebt: z.string(),
+  variableTokenDebt: z.string(),
+  reserve: Reserve$outboundSchema,
+  assetPriceUSD: 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 Borrow$ {
+  /** @deprecated use `Borrow$inboundSchema` instead. */
+  export const inboundSchema = Borrow$inboundSchema;
+  /** @deprecated use `Borrow$outboundSchema` instead. */
+  export const outboundSchema = Borrow$outboundSchema;
+  /** @deprecated use `Borrow$Outbound` instead. */
+  export type Outbound = Borrow$Outbound;
+}
+
+export function borrowToJSON(borrow: Borrow): string {
+  return JSON.stringify(Borrow$outboundSchema.parse(borrow));
+}
+
+export function borrowFromJSON(
+  jsonString: string,
+): SafeParseResult<Borrow, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Borrow$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Borrow' from JSON`,
+  );
+}

package/src/models/components/collateralreserve.ts

@@ -0,0 +1,70 @@
+/*
+ * 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";
+
+export type CollateralReserve = {
+  symbol: string;
+  decimals: number;
+};
+
+/** @internal */
+export const CollateralReserve$inboundSchema: z.ZodType<
+  CollateralReserve,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  symbol: z.string(),
+  decimals: z.number().int(),
+});
+
+/** @internal */
+export type CollateralReserve$Outbound = {
+  symbol: string;
+  decimals: number;
+};
+
+/** @internal */
+export const CollateralReserve$outboundSchema: z.ZodType<
+  CollateralReserve$Outbound,
+  z.ZodTypeDef,
+  CollateralReserve
+> = z.object({
+  symbol: z.string(),
+  decimals: 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 CollateralReserve$ {
+  /** @deprecated use `CollateralReserve$inboundSchema` instead. */
+  export const inboundSchema = CollateralReserve$inboundSchema;
+  /** @deprecated use `CollateralReserve$outboundSchema` instead. */
+  export const outboundSchema = CollateralReserve$outboundSchema;
+  /** @deprecated use `CollateralReserve$Outbound` instead. */
+  export type Outbound = CollateralReserve$Outbound;
+}
+
+export function collateralReserveToJSON(
+  collateralReserve: CollateralReserve,
+): string {
+  return JSON.stringify(
+    CollateralReserve$outboundSchema.parse(collateralReserve),
+  );
+}
+
+export function collateralReserveFromJSON(
+  jsonString: string,
+): SafeParseResult<CollateralReserve, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CollateralReserve$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CollateralReserve' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -4,6 +4,8 @@
 
 export * from "./aaveborrowparams.js";
 export * from "./aaveborrowrequest.js";
+export * from "./aavehistoricaltransactionbase.js";
+export * from "./aavehistoricaltransactionsresponse.js";
 export * from "./aaveliquiditychangeresponse.js";
 export * from "./aaverepayparams.js";
 export * from "./aaverepayrequest.js";
@@ -14,6 +16,7 @@ export * from "./aaveuserpositionpertokenresponse.js";
 export * from "./aaveuserpositionsummaryresponse.js";
 export * from "./aavewithdrawparams.js";
 export * from "./aavewithdrawrequest.js";
+export * from "./action.js";
 export * from "./aerodromeaddliquidityethparams.js";
 export * from "./aerodromeaddliquidityparams.js";
 export * from "./aerodromelppositionsresponse.js";
@@ -35,8 +38,10 @@ export * from "./aerodromeswapethfortokenparams.js";
 export * from "./aerodromeswaptokenforethparams.js";
 export * from "./aerodromeswaptokensparams.js";
 export * from "./allowanceinforesponse.js";
+export * from "./borrow.js";
 export * from "./chain.js";
 export * from "./chaininfo.js";
+export * from "./collateralreserve.js";
 export * from "./compassapibackendmodelsmorphoreadresponsegetmarketsasset.js";
 export * from "./compassapibackendmodelsmorphoreadresponsegetvaultsasset.js";
 export * from "./contractname.js";
@@ -47,6 +52,7 @@ export * from "./increaseallowanceanyparams.js";
 export * from "./increaseallowanceparams.js";
 export * from "./increaseallowancerequest.js";
 export * from "./interestratemode.js";
+export * from "./liquidationcall.js";
 export * from "./marketstate.js";
 export * from "./morphoborrowrequest.js";
 export * from "./morphocheckmarketpositionresponse.js";
@@ -67,6 +73,10 @@ export * from "./multicallauthorizationrequest.js";
 export * from "./multicallauthorizationresponse.js";
 export * from "./multicallexecuterequest.js";
 export * from "./portfolio.js";
+export * from "./principalreserve.js";
+export * from "./redeemunderlying.js";
+export * from "./repay.js";
+export * from "./reserve.js";
 export * from "./security.js";
 export * from "./signedauthorization.js";
 export * from "./skybuyrequest.js";
@@ -74,6 +84,8 @@ export * from "./skycheckpositionresponse.js";
 export * from "./skydepositrequest.js";
 export * from "./skysellrequest.js";
 export * from "./skywithdrawrequest.js";
+export * from "./supply.js";
+export * from "./swapborrowrate.js";
 export * from "./tokenaddressresponse.js";
 export * from "./tokenbalance.js";
 export * from "./tokenbalanceresponse.js";
@@ -102,6 +114,7 @@ export * from "./unsignedmulticalltransaction.js";
 export * from "./unsignedtransaction.js";
 export * from "./unwrapwethparams.js";
 export * from "./unwrapwethrequest.js";
+export * from "./usageascollateral.js";
 export * from "./validationerror.js";
 export * from "./vaultstate.js";
 export * from "./weeklyapys.js";

package/src/models/components/liquidationcall.ts

@@ -0,0 +1,96 @@
+/*
+ * 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 {
+  CollateralReserve,
+  CollateralReserve$inboundSchema,
+  CollateralReserve$Outbound,
+  CollateralReserve$outboundSchema,
+} from "./collateralreserve.js";
+import {
+  PrincipalReserve,
+  PrincipalReserve$inboundSchema,
+  PrincipalReserve$Outbound,
+  PrincipalReserve$outboundSchema,
+} from "./principalreserve.js";
+
+export type LiquidationCall = {
+  collateralAmount: string;
+  collateralReserve: CollateralReserve;
+  principalAmount: string;
+  principalReserve: PrincipalReserve;
+  collateralAssetPriceUSD: string;
+  borrowAssetPriceUSD: string;
+};
+
+/** @internal */
+export const LiquidationCall$inboundSchema: z.ZodType<
+  LiquidationCall,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  collateralAmount: z.string(),
+  collateralReserve: CollateralReserve$inboundSchema,
+  principalAmount: z.string(),
+  principalReserve: PrincipalReserve$inboundSchema,
+  collateralAssetPriceUSD: z.string(),
+  borrowAssetPriceUSD: z.string(),
+});
+
+/** @internal */
+export type LiquidationCall$Outbound = {
+  collateralAmount: string;
+  collateralReserve: CollateralReserve$Outbound;
+  principalAmount: string;
+  principalReserve: PrincipalReserve$Outbound;
+  collateralAssetPriceUSD: string;
+  borrowAssetPriceUSD: string;
+};
+
+/** @internal */
+export const LiquidationCall$outboundSchema: z.ZodType<
+  LiquidationCall$Outbound,
+  z.ZodTypeDef,
+  LiquidationCall
+> = z.object({
+  collateralAmount: z.string(),
+  collateralReserve: CollateralReserve$outboundSchema,
+  principalAmount: z.string(),
+  principalReserve: PrincipalReserve$outboundSchema,
+  collateralAssetPriceUSD: z.string(),
+  borrowAssetPriceUSD: 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 LiquidationCall$ {
+  /** @deprecated use `LiquidationCall$inboundSchema` instead. */
+  export const inboundSchema = LiquidationCall$inboundSchema;
+  /** @deprecated use `LiquidationCall$outboundSchema` instead. */
+  export const outboundSchema = LiquidationCall$outboundSchema;
+  /** @deprecated use `LiquidationCall$Outbound` instead. */
+  export type Outbound = LiquidationCall$Outbound;
+}
+
+export function liquidationCallToJSON(
+  liquidationCall: LiquidationCall,
+): string {
+  return JSON.stringify(LiquidationCall$outboundSchema.parse(liquidationCall));
+}
+
+export function liquidationCallFromJSON(
+  jsonString: string,
+): SafeParseResult<LiquidationCall, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LiquidationCall$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LiquidationCall' from JSON`,
+  );
+}

package/src/models/components/multicallauthorizationrequest.ts

@@ -16,6 +16,8 @@ import { Chain, Chain$inboundSchema, Chain$outboundSchema } from "./chain.js";
  * 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 = {
   /**

package/src/models/components/principalreserve.ts

@@ -0,0 +1,70 @@
+/*
+ * 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";
+
+export type PrincipalReserve = {
+  symbol: string;
+  decimals: number;
+};
+
+/** @internal */
+export const PrincipalReserve$inboundSchema: z.ZodType<
+  PrincipalReserve,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  symbol: z.string(),
+  decimals: z.number().int(),
+});
+
+/** @internal */
+export type PrincipalReserve$Outbound = {
+  symbol: string;
+  decimals: number;
+};
+
+/** @internal */
+export const PrincipalReserve$outboundSchema: z.ZodType<
+  PrincipalReserve$Outbound,
+  z.ZodTypeDef,
+  PrincipalReserve
+> = z.object({
+  symbol: z.string(),
+  decimals: 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 PrincipalReserve$ {
+  /** @deprecated use `PrincipalReserve$inboundSchema` instead. */
+  export const inboundSchema = PrincipalReserve$inboundSchema;
+  /** @deprecated use `PrincipalReserve$outboundSchema` instead. */
+  export const outboundSchema = PrincipalReserve$outboundSchema;
+  /** @deprecated use `PrincipalReserve$Outbound` instead. */
+  export type Outbound = PrincipalReserve$Outbound;
+}
+
+export function principalReserveToJSON(
+  principalReserve: PrincipalReserve,
+): string {
+  return JSON.stringify(
+    PrincipalReserve$outboundSchema.parse(principalReserve),
+  );
+}
+
+export function principalReserveFromJSON(
+  jsonString: string,
+): SafeParseResult<PrincipalReserve, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PrincipalReserve$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PrincipalReserve' from JSON`,
+  );
+}

package/src/models/components/redeemunderlying.ts

@@ -0,0 +1,80 @@
+/*
+ * 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 {
+  Reserve,
+  Reserve$inboundSchema,
+  Reserve$Outbound,
+  Reserve$outboundSchema,
+} from "./reserve.js";
+
+export type RedeemUnderlying = {
+  amount: string;
+  reserve: Reserve;
+  assetPriceUSD: string;
+};
+
+/** @internal */
+export const RedeemUnderlying$inboundSchema: z.ZodType<
+  RedeemUnderlying,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amount: z.string(),
+  reserve: Reserve$inboundSchema,
+  assetPriceUSD: z.string(),
+});
+
+/** @internal */
+export type RedeemUnderlying$Outbound = {
+  amount: string;
+  reserve: Reserve$Outbound;
+  assetPriceUSD: string;
+};
+
+/** @internal */
+export const RedeemUnderlying$outboundSchema: z.ZodType<
+  RedeemUnderlying$Outbound,
+  z.ZodTypeDef,
+  RedeemUnderlying
+> = z.object({
+  amount: z.string(),
+  reserve: Reserve$outboundSchema,
+  assetPriceUSD: 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 RedeemUnderlying$ {
+  /** @deprecated use `RedeemUnderlying$inboundSchema` instead. */
+  export const inboundSchema = RedeemUnderlying$inboundSchema;
+  /** @deprecated use `RedeemUnderlying$outboundSchema` instead. */
+  export const outboundSchema = RedeemUnderlying$outboundSchema;
+  /** @deprecated use `RedeemUnderlying$Outbound` instead. */
+  export type Outbound = RedeemUnderlying$Outbound;
+}
+
+export function redeemUnderlyingToJSON(
+  redeemUnderlying: RedeemUnderlying,
+): string {
+  return JSON.stringify(
+    RedeemUnderlying$outboundSchema.parse(redeemUnderlying),
+  );
+}
+
+export function redeemUnderlyingFromJSON(
+  jsonString: string,
+): SafeParseResult<RedeemUnderlying, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RedeemUnderlying$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RedeemUnderlying' from JSON`,
+  );
+}

package/src/models/components/repay.ts

@@ -0,0 +1,73 @@
+/*
+ * 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 {
+  Reserve,
+  Reserve$inboundSchema,
+  Reserve$Outbound,
+  Reserve$outboundSchema,
+} from "./reserve.js";
+
+export type Repay = {
+  amount: string;
+  reserve: Reserve;
+  assetPriceUSD: string;
+};
+
+/** @internal */
+export const Repay$inboundSchema: z.ZodType<Repay, z.ZodTypeDef, unknown> = z
+  .object({
+    amount: z.string(),
+    reserve: Reserve$inboundSchema,
+    assetPriceUSD: z.string(),
+  });
+
+/** @internal */
+export type Repay$Outbound = {
+  amount: string;
+  reserve: Reserve$Outbound;
+  assetPriceUSD: string;
+};
+
+/** @internal */
+export const Repay$outboundSchema: z.ZodType<
+  Repay$Outbound,
+  z.ZodTypeDef,
+  Repay
+> = z.object({
+  amount: z.string(),
+  reserve: Reserve$outboundSchema,
+  assetPriceUSD: 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 Repay$ {
+  /** @deprecated use `Repay$inboundSchema` instead. */
+  export const inboundSchema = Repay$inboundSchema;
+  /** @deprecated use `Repay$outboundSchema` instead. */
+  export const outboundSchema = Repay$outboundSchema;
+  /** @deprecated use `Repay$Outbound` instead. */
+  export type Outbound = Repay$Outbound;
+}
+
+export function repayToJSON(repay: Repay): string {
+  return JSON.stringify(Repay$outboundSchema.parse(repay));
+}
+
+export function repayFromJSON(
+  jsonString: string,
+): SafeParseResult<Repay, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Repay$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Repay' from JSON`,
+  );
+}