@compass-labs/api-sdk 1.0.2 → 1.0.3

package/src/models/components/aavelooprequest.ts

@@ -0,0 +1,407 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  SignedAuthorization,
+  SignedAuthorization$inboundSchema,
+  SignedAuthorization$Outbound,
+  SignedAuthorization$outboundSchema,
+} from "./signedauthorization.js";
+import {
+  TokenEnum,
+  TokenEnum$inboundSchema,
+  TokenEnum$outboundSchema,
+} from "./tokenenum.js";
+
+export const AaveLoopRequestChain = {
+  Arbitrum: "arbitrum",
+  Base: "base",
+  Ethereum: "ethereum",
+} as const;
+export type AaveLoopRequestChain = ClosedEnum<typeof AaveLoopRequestChain>;
+
+/**
+ * Amount of collateral token to supply to Aave
+ */
+export type InitialCollateralAmount = number | string;
+
+/**
+ * Leverage multiplier. 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 = {
+  chain: AaveLoopRequestChain;
+  /**
+   * The address of the transaction sender.
+   */
+  sender: string;
+  /**
+   * EIP-7702 authorization. Required when `is_account_abstraction` is False.
+   */
+  signedAuthorization?: SignedAuthorization | null | undefined;
+  /**
+   * 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;
+  /**
+   * Leverage multiplier. 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;
+  /**
+   * Whether to use account abstraction for the transaction.
+   */
+  isAccountAbstraction?: boolean | undefined;
+};
+
+/** @internal */
+export const AaveLoopRequestChain$inboundSchema: z.ZodNativeEnum<
+  typeof AaveLoopRequestChain
+> = z.nativeEnum(AaveLoopRequestChain);
+
+/** @internal */
+export const AaveLoopRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof AaveLoopRequestChain
+> = AaveLoopRequestChain$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveLoopRequestChain$ {
+  /** @deprecated use `AaveLoopRequestChain$inboundSchema` instead. */
+  export const inboundSchema = AaveLoopRequestChain$inboundSchema;
+  /** @deprecated use `AaveLoopRequestChain$outboundSchema` instead. */
+  export const outboundSchema = AaveLoopRequestChain$outboundSchema;
+}
+
+/** @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: AaveLoopRequestChain$inboundSchema,
+  sender: z.string(),
+  signed_authorization: z.nullable(SignedAuthorization$inboundSchema)
+    .optional(),
+  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()]),
+  is_account_abstraction: z.boolean().default(false),
+}).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",
+    "is_account_abstraction": "isAccountAbstraction",
+  });
+});
+
+/** @internal */
+export type AaveLoopRequest$Outbound = {
+  chain: string;
+  sender: string;
+  signed_authorization?: SignedAuthorization$Outbound | null | undefined;
+  collateral_token: string;
+  borrow_token: string;
+  initial_collateral_amount: number | string;
+  multiplier: number | string;
+  max_slippage_percent: number | string;
+  loan_to_value: number | string;
+  is_account_abstraction: boolean;
+};
+
+/** @internal */
+export const AaveLoopRequest$outboundSchema: z.ZodType<
+  AaveLoopRequest$Outbound,
+  z.ZodTypeDef,
+  AaveLoopRequest
+> = z.object({
+  chain: AaveLoopRequestChain$outboundSchema,
+  sender: z.string(),
+  signedAuthorization: z.nullable(SignedAuthorization$outboundSchema)
+    .optional(),
+  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()]),
+  isAccountAbstraction: z.boolean().default(false),
+}).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",
+    isAccountAbstraction: "is_account_abstraction",
+  });
+});
+
+/**
+ * @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/aaverepayrequest.ts

@@ -0,0 +1,219 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  InterestRateMode,
+  InterestRateMode$inboundSchema,
+  InterestRateMode$outboundSchema,
+} from "./interestratemode.js";
+import {
+  TokenEnum,
+  TokenEnum$inboundSchema,
+  TokenEnum$outboundSchema,
+} from "./tokenenum.js";
+
+/**
+ * The amount of the asset to repay
+ */
+export type AaveRepayRequestAmount = number | string;
+
+export const AaveRepayRequestChain = {
+  Arbitrum: "arbitrum",
+  Base: "base",
+  Ethereum: "ethereum",
+} as const;
+export type AaveRepayRequestChain = ClosedEnum<typeof AaveRepayRequestChain>;
+
+export type AaveRepayRequest = {
+  actionType?: "AAVE_REPAY" | undefined;
+  /**
+   * 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.
+   */
+  token: TokenEnum;
+  /**
+   * The amount of the asset to repay
+   */
+  amount: number | string;
+  /**
+   * On AAVE there are 2 different interest modes.
+   *
+   * @remarks
+   *
+   * A stable (but typically higher rate), or a variable rate.
+   */
+  interestRateMode: InterestRateMode;
+  /**
+   * The address on behalf of whom the supply is made
+   */
+  onBehalfOf?: string | null | undefined;
+  chain: AaveRepayRequestChain;
+  /**
+   * The address of the transaction sender.
+   */
+  sender: string;
+};
+
+/** @internal */
+export const AaveRepayRequestAmount$inboundSchema: z.ZodType<
+  AaveRepayRequestAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type AaveRepayRequestAmount$Outbound = number | string;
+
+/** @internal */
+export const AaveRepayRequestAmount$outboundSchema: z.ZodType<
+  AaveRepayRequestAmount$Outbound,
+  z.ZodTypeDef,
+  AaveRepayRequestAmount
+> = 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 AaveRepayRequestAmount$ {
+  /** @deprecated use `AaveRepayRequestAmount$inboundSchema` instead. */
+  export const inboundSchema = AaveRepayRequestAmount$inboundSchema;
+  /** @deprecated use `AaveRepayRequestAmount$outboundSchema` instead. */
+  export const outboundSchema = AaveRepayRequestAmount$outboundSchema;
+  /** @deprecated use `AaveRepayRequestAmount$Outbound` instead. */
+  export type Outbound = AaveRepayRequestAmount$Outbound;
+}
+
+export function aaveRepayRequestAmountToJSON(
+  aaveRepayRequestAmount: AaveRepayRequestAmount,
+): string {
+  return JSON.stringify(
+    AaveRepayRequestAmount$outboundSchema.parse(aaveRepayRequestAmount),
+  );
+}
+
+export function aaveRepayRequestAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveRepayRequestAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveRepayRequestAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveRepayRequestAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const AaveRepayRequestChain$inboundSchema: z.ZodNativeEnum<
+  typeof AaveRepayRequestChain
+> = z.nativeEnum(AaveRepayRequestChain);
+
+/** @internal */
+export const AaveRepayRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof AaveRepayRequestChain
+> = AaveRepayRequestChain$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveRepayRequestChain$ {
+  /** @deprecated use `AaveRepayRequestChain$inboundSchema` instead. */
+  export const inboundSchema = AaveRepayRequestChain$inboundSchema;
+  /** @deprecated use `AaveRepayRequestChain$outboundSchema` instead. */
+  export const outboundSchema = AaveRepayRequestChain$outboundSchema;
+}
+
+/** @internal */
+export const AaveRepayRequest$inboundSchema: z.ZodType<
+  AaveRepayRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  action_type: z.literal("AAVE_REPAY").default("AAVE_REPAY"),
+  token: TokenEnum$inboundSchema,
+  amount: z.union([z.number(), z.string()]),
+  interest_rate_mode: InterestRateMode$inboundSchema,
+  on_behalf_of: z.nullable(z.string()).optional(),
+  chain: AaveRepayRequestChain$inboundSchema,
+  sender: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "action_type": "actionType",
+    "interest_rate_mode": "interestRateMode",
+    "on_behalf_of": "onBehalfOf",
+  });
+});
+
+/** @internal */
+export type AaveRepayRequest$Outbound = {
+  action_type: "AAVE_REPAY";
+  token: string;
+  amount: number | string;
+  interest_rate_mode: string;
+  on_behalf_of?: string | null | undefined;
+  chain: string;
+  sender: string;
+};
+
+/** @internal */
+export const AaveRepayRequest$outboundSchema: z.ZodType<
+  AaveRepayRequest$Outbound,
+  z.ZodTypeDef,
+  AaveRepayRequest
+> = z.object({
+  actionType: z.literal("AAVE_REPAY").default("AAVE_REPAY" as const),
+  token: TokenEnum$outboundSchema,
+  amount: z.union([z.number(), z.string()]),
+  interestRateMode: InterestRateMode$outboundSchema,
+  onBehalfOf: z.nullable(z.string()).optional(),
+  chain: AaveRepayRequestChain$outboundSchema,
+  sender: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    actionType: "action_type",
+    interestRateMode: "interest_rate_mode",
+    onBehalfOf: "on_behalf_of",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AaveRepayRequest$ {
+  /** @deprecated use `AaveRepayRequest$inboundSchema` instead. */
+  export const inboundSchema = AaveRepayRequest$inboundSchema;
+  /** @deprecated use `AaveRepayRequest$outboundSchema` instead. */
+  export const outboundSchema = AaveRepayRequest$outboundSchema;
+  /** @deprecated use `AaveRepayRequest$Outbound` instead. */
+  export type Outbound = AaveRepayRequest$Outbound;
+}
+
+export function aaveRepayRequestToJSON(
+  aaveRepayRequest: AaveRepayRequest,
+): string {
+  return JSON.stringify(
+    AaveRepayRequest$outboundSchema.parse(aaveRepayRequest),
+  );
+}
+
+export function aaveRepayRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<AaveRepayRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AaveRepayRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AaveRepayRequest' from JSON`,
+  );
+}