@compass-labs/api-sdk 2.2.19 → 2.2.20-rc.0

package/src/models/components/creditrepayparams.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  InterestRateMode,
+  InterestRateMode$outboundSchema,
+} from "./interestratemode.js";
+
+/**
+ * Amount in token units to repay.
+ */
+export type CreditRepayParamsAmount = number | string;
+
+/**
+ * Repay debt to Aave via Credit Account.
+ */
+export type CreditRepayParams = {
+  actionType: "CREDIT_REPAY";
+  /**
+   * Token to repay to Aave.
+   */
+  token: string;
+  /**
+   * Amount in token units 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 | undefined;
+};
+
+/** @internal */
+export type CreditRepayParamsAmount$Outbound = number | string;
+
+/** @internal */
+export const CreditRepayParamsAmount$outboundSchema: z.ZodType<
+  CreditRepayParamsAmount$Outbound,
+  z.ZodTypeDef,
+  CreditRepayParamsAmount
+> = z.union([z.number(), z.string()]);
+
+export function creditRepayParamsAmountToJSON(
+  creditRepayParamsAmount: CreditRepayParamsAmount,
+): string {
+  return JSON.stringify(
+    CreditRepayParamsAmount$outboundSchema.parse(creditRepayParamsAmount),
+  );
+}
+
+/** @internal */
+export type CreditRepayParams$Outbound = {
+  action_type: "CREDIT_REPAY";
+  token: string;
+  amount: number | string;
+  interest_rate_mode?: string | undefined;
+};
+
+/** @internal */
+export const CreditRepayParams$outboundSchema: z.ZodType<
+  CreditRepayParams$Outbound,
+  z.ZodTypeDef,
+  CreditRepayParams
+> = z.object({
+  actionType: z.literal("CREDIT_REPAY"),
+  token: z.string(),
+  amount: z.union([z.number(), z.string()]),
+  interestRateMode: InterestRateMode$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    actionType: "action_type",
+    interestRateMode: "interest_rate_mode",
+  });
+});
+
+export function creditRepayParamsToJSON(
+  creditRepayParams: CreditRepayParams,
+): string {
+  return JSON.stringify(
+    CreditRepayParams$outboundSchema.parse(creditRepayParams),
+  );
+}

package/src/models/components/creditrepayrequest.ts

@@ -0,0 +1,190 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { Chain, Chain$outboundSchema } from "./chain.js";
+import {
+  InterestRateMode,
+  InterestRateMode$outboundSchema,
+} from "./interestratemode.js";
+
+/**
+ * Amount of repay_token to repay (in token units, not wei).
+ */
+export type RepayAmount = number | string;
+
+/**
+ * Amount of collateral to withdraw (in token units, not wei).
+ */
+export type WithdrawAmount = number | string;
+
+/**
+ * Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). Only used when a swap is needed.
+ */
+export type CreditRepayRequestSlippage = number | string;
+
+export type CreditRepayRequest = {
+  /**
+   * The address that owns the Credit Account.
+   */
+  owner: string;
+  /**
+   * The chain to use.
+   */
+  chain: Chain;
+  /**
+   * The borrowed asset to repay (e.g. WETH). Must match the debt position's token.
+   */
+  repayToken: string;
+  /**
+   * Amount of repay_token to repay (in token units, not wei).
+   */
+  repayAmount: number | string;
+  /**
+   * On AAVE there are 2 different interest modes.
+   *
+   * @remarks
+   *
+   * A stable (but typically higher rate), or a variable rate.
+   */
+  interestRateMode?: InterestRateMode | undefined;
+  /**
+   * Collateral token to withdraw from Aave after repaying debt.
+   */
+  withdrawToken: string;
+  /**
+   * Amount of collateral to withdraw (in token units, not wei).
+   */
+  withdrawAmount: number | string;
+  /**
+   * Desired output token. If different from withdraw_token, a swap is performed after withdrawal. If None, the withdrawn collateral is kept as-is.
+   */
+  tokenOut?: string | null | undefined;
+  /**
+   * Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). Only used when a swap is needed.
+   */
+  slippage?: number | string | undefined;
+  /**
+   * If true, returns EIP-712 signature data instead of an unsigned transaction.
+   */
+  gasSponsorship?: boolean | undefined;
+  /**
+   * The EOA owner's signature of the Permit2 PermitTransferFrom typed data. When provided, the repay bundle will first pull repay_token from the owner's EOA into the Credit Account via Permit2. Obtain by calling /v2/credit/transfer and signing the returned EIP-712 data.
+   */
+  permit2Signature?: string | null | undefined;
+  /**
+   * The nonce used in the Permit2 signature (from the signed typed data).
+   */
+  permit2Nonce?: number | null | undefined;
+  /**
+   * The deadline timestamp used in the Permit2 signature (from the signed typed data).
+   */
+  permit2Deadline?: number | null | undefined;
+};
+
+/** @internal */
+export type RepayAmount$Outbound = number | string;
+
+/** @internal */
+export const RepayAmount$outboundSchema: z.ZodType<
+  RepayAmount$Outbound,
+  z.ZodTypeDef,
+  RepayAmount
+> = z.union([z.number(), z.string()]);
+
+export function repayAmountToJSON(repayAmount: RepayAmount): string {
+  return JSON.stringify(RepayAmount$outboundSchema.parse(repayAmount));
+}
+
+/** @internal */
+export type WithdrawAmount$Outbound = number | string;
+
+/** @internal */
+export const WithdrawAmount$outboundSchema: z.ZodType<
+  WithdrawAmount$Outbound,
+  z.ZodTypeDef,
+  WithdrawAmount
+> = z.union([z.number(), z.string()]);
+
+export function withdrawAmountToJSON(withdrawAmount: WithdrawAmount): string {
+  return JSON.stringify(WithdrawAmount$outboundSchema.parse(withdrawAmount));
+}
+
+/** @internal */
+export type CreditRepayRequestSlippage$Outbound = number | string;
+
+/** @internal */
+export const CreditRepayRequestSlippage$outboundSchema: z.ZodType<
+  CreditRepayRequestSlippage$Outbound,
+  z.ZodTypeDef,
+  CreditRepayRequestSlippage
+> = z.union([z.number(), z.string()]);
+
+export function creditRepayRequestSlippageToJSON(
+  creditRepayRequestSlippage: CreditRepayRequestSlippage,
+): string {
+  return JSON.stringify(
+    CreditRepayRequestSlippage$outboundSchema.parse(creditRepayRequestSlippage),
+  );
+}
+
+/** @internal */
+export type CreditRepayRequest$Outbound = {
+  owner: string;
+  chain: string;
+  repay_token: string;
+  repay_amount: number | string;
+  interest_rate_mode?: string | undefined;
+  withdraw_token: string;
+  withdraw_amount: number | string;
+  token_out?: string | null | undefined;
+  slippage?: number | string | undefined;
+  gas_sponsorship?: boolean | undefined;
+  permit2_signature?: string | null | undefined;
+  permit2_nonce?: number | null | undefined;
+  permit2_deadline?: number | null | undefined;
+};
+
+/** @internal */
+export const CreditRepayRequest$outboundSchema: z.ZodType<
+  CreditRepayRequest$Outbound,
+  z.ZodTypeDef,
+  CreditRepayRequest
+> = z.object({
+  owner: z.string(),
+  chain: Chain$outboundSchema,
+  repayToken: z.string(),
+  repayAmount: z.union([z.number(), z.string()]),
+  interestRateMode: InterestRateMode$outboundSchema.optional(),
+  withdrawToken: z.string(),
+  withdrawAmount: z.union([z.number(), z.string()]),
+  tokenOut: z.nullable(z.string()).optional(),
+  slippage: z.union([z.number(), z.string()]).optional(),
+  gasSponsorship: z.boolean().optional(),
+  permit2Signature: z.nullable(z.string()).optional(),
+  permit2Nonce: z.nullable(z.number().int()).optional(),
+  permit2Deadline: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    repayToken: "repay_token",
+    repayAmount: "repay_amount",
+    interestRateMode: "interest_rate_mode",
+    withdrawToken: "withdraw_token",
+    withdrawAmount: "withdraw_amount",
+    tokenOut: "token_out",
+    gasSponsorship: "gas_sponsorship",
+    permit2Signature: "permit2_signature",
+    permit2Nonce: "permit2_nonce",
+    permit2Deadline: "permit2_deadline",
+  });
+});
+
+export function creditRepayRequestToJSON(
+  creditRepayRequest: CreditRepayRequest,
+): string {
+  return JSON.stringify(
+    CreditRepayRequest$outboundSchema.parse(creditRepayRequest),
+  );
+}

package/src/models/components/creditrepayresponse.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  BatchedSafeOperationsResponseOutput,
+  BatchedSafeOperationsResponseOutput$inboundSchema,
+} from "./batchedsafeoperationsresponseoutput.js";
+import {
+  UnsignedTransaction,
+  UnsignedTransaction$inboundSchema,
+} from "./unsignedtransaction.js";
+
+export type CreditRepayResponse = {
+  /**
+   * Unsigned transaction to execute the repay bundle. Present when gas_sponsorship is false.
+   */
+  transaction?: UnsignedTransaction | null | undefined;
+  /**
+   * EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship is true.
+   */
+  eip712?: BatchedSafeOperationsResponseOutput | null | undefined;
+  /**
+   * Estimated amount of token_out received from swap. Only present when token_out differs from withdraw_token.
+   */
+  estimatedTokenOutAmount?: string | null | undefined;
+};
+
+/** @internal */
+export const CreditRepayResponse$inboundSchema: z.ZodType<
+  CreditRepayResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transaction: z.nullable(UnsignedTransaction$inboundSchema).optional(),
+  eip_712: z.nullable(BatchedSafeOperationsResponseOutput$inboundSchema)
+    .optional(),
+  estimated_token_out_amount: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "eip_712": "eip712",
+    "estimated_token_out_amount": "estimatedTokenOutAmount",
+  });
+});
+
+export function creditRepayResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreditRepayResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreditRepayResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreditRepayResponse' from JSON`,
+  );
+}

package/src/models/components/creditsupplyparams.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+/**
+ * Amount in token units to supply.
+ */
+export type CreditSupplyParamsAmount = number | string;
+
+/**
+ * Supply collateral to Aave via Credit Account.
+ */
+export type CreditSupplyParams = {
+  actionType: "CREDIT_SUPPLY";
+  /**
+   * Collateral token to supply to Aave.
+   */
+  token: string;
+  /**
+   * Amount in token units to supply.
+   */
+  amount: number | string;
+};
+
+/** @internal */
+export type CreditSupplyParamsAmount$Outbound = number | string;
+
+/** @internal */
+export const CreditSupplyParamsAmount$outboundSchema: z.ZodType<
+  CreditSupplyParamsAmount$Outbound,
+  z.ZodTypeDef,
+  CreditSupplyParamsAmount
+> = z.union([z.number(), z.string()]);
+
+export function creditSupplyParamsAmountToJSON(
+  creditSupplyParamsAmount: CreditSupplyParamsAmount,
+): string {
+  return JSON.stringify(
+    CreditSupplyParamsAmount$outboundSchema.parse(creditSupplyParamsAmount),
+  );
+}
+
+/** @internal */
+export type CreditSupplyParams$Outbound = {
+  action_type: "CREDIT_SUPPLY";
+  token: string;
+  amount: number | string;
+};
+
+/** @internal */
+export const CreditSupplyParams$outboundSchema: z.ZodType<
+  CreditSupplyParams$Outbound,
+  z.ZodTypeDef,
+  CreditSupplyParams
+> = z.object({
+  actionType: z.literal("CREDIT_SUPPLY"),
+  token: z.string(),
+  amount: z.union([z.number(), z.string()]),
+}).transform((v) => {
+  return remap$(v, {
+    actionType: "action_type",
+  });
+});
+
+export function creditSupplyParamsToJSON(
+  creditSupplyParams: CreditSupplyParams,
+): string {
+  return JSON.stringify(
+    CreditSupplyParams$outboundSchema.parse(creditSupplyParams),
+  );
+}

package/src/models/components/credittransferrequest.ts

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { Chain, Chain$outboundSchema } from "./chain.js";
+
+/**
+ * The amount of tokens to transfer (in token units, not wei).
+ */
+export type CreditTransferRequestAmount = number | string;
+
+export type CreditTransferRequest = {
+  /**
+   * The owner's wallet address (EOA).
+   */
+  owner: string;
+  /**
+   * The chain to use.
+   */
+  chain: Chain;
+  /**
+   * The token to transfer from the EOA to the Credit Account.
+   */
+  token: string;
+  /**
+   * The amount of tokens to transfer (in token units, not wei).
+   */
+  amount: number | string;
+};
+
+/** @internal */
+export type CreditTransferRequestAmount$Outbound = number | string;
+
+/** @internal */
+export const CreditTransferRequestAmount$outboundSchema: z.ZodType<
+  CreditTransferRequestAmount$Outbound,
+  z.ZodTypeDef,
+  CreditTransferRequestAmount
+> = z.union([z.number(), z.string()]);
+
+export function creditTransferRequestAmountToJSON(
+  creditTransferRequestAmount: CreditTransferRequestAmount,
+): string {
+  return JSON.stringify(
+    CreditTransferRequestAmount$outboundSchema.parse(
+      creditTransferRequestAmount,
+    ),
+  );
+}
+
+/** @internal */
+export type CreditTransferRequest$Outbound = {
+  owner: string;
+  chain: string;
+  token: string;
+  amount: number | string;
+};
+
+/** @internal */
+export const CreditTransferRequest$outboundSchema: z.ZodType<
+  CreditTransferRequest$Outbound,
+  z.ZodTypeDef,
+  CreditTransferRequest
+> = z.object({
+  owner: z.string(),
+  chain: Chain$outboundSchema,
+  token: z.string(),
+  amount: z.union([z.number(), z.string()]),
+});
+
+export function creditTransferRequestToJSON(
+  creditTransferRequest: CreditTransferRequest,
+): string {
+  return JSON.stringify(
+    CreditTransferRequest$outboundSchema.parse(creditTransferRequest),
+  );
+}

package/src/models/components/credittransferresponse.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  Permit2TypedDataOutput,
+  Permit2TypedDataOutput$inboundSchema,
+} from "./permit2typeddataoutput.js";
+
+export type CreditTransferResponse = {
+  eip712: Permit2TypedDataOutput;
+};
+
+/** @internal */
+export const CreditTransferResponse$inboundSchema: z.ZodType<
+  CreditTransferResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  eip_712: Permit2TypedDataOutput$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "eip_712": "eip712",
+  });
+});
+
+export function creditTransferResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreditTransferResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreditTransferResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreditTransferResponse' from JSON`,
+  );
+}

package/src/models/components/credituseroperation.ts

@@ -0,0 +1,133 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  CreditBorrowParams,
+  CreditBorrowParams$Outbound,
+  CreditBorrowParams$outboundSchema,
+} from "./creditborrowparams.js";
+import {
+  CreditRepayParams,
+  CreditRepayParams$Outbound,
+  CreditRepayParams$outboundSchema,
+} from "./creditrepayparams.js";
+import {
+  CreditSupplyParams,
+  CreditSupplyParams$Outbound,
+  CreditSupplyParams$outboundSchema,
+} from "./creditsupplyparams.js";
+import {
+  CreditWithdrawParams,
+  CreditWithdrawParams$Outbound,
+  CreditWithdrawParams$outboundSchema,
+} from "./creditwithdrawparams.js";
+import {
+  EarnSwapParams,
+  EarnSwapParams$Outbound,
+  EarnSwapParams$outboundSchema,
+} from "./earnswapparams.js";
+import {
+  EarnTransferFromEOAParams,
+  EarnTransferFromEOAParams$Outbound,
+  EarnTransferFromEOAParams$outboundSchema,
+} from "./earntransferfromeoaparams.js";
+import {
+  EarnTransferToEOAParams,
+  EarnTransferToEOAParams$Outbound,
+  EarnTransferToEOAParams$outboundSchema,
+} from "./earntransfertoeoaparams.js";
+
+export type CreditUserOperationBody =
+  | CreditBorrowParams
+  | CreditRepayParams
+  | CreditSupplyParams
+  | CreditWithdrawParams
+  | EarnSwapParams
+  | EarnTransferFromEOAParams
+  | EarnTransferToEOAParams;
+
+/**
+ * A single operation in a credit bundle.
+ */
+export type CreditUserOperation = {
+  body:
+    | CreditBorrowParams
+    | CreditRepayParams
+    | CreditSupplyParams
+    | CreditWithdrawParams
+    | EarnSwapParams
+    | EarnTransferFromEOAParams
+    | EarnTransferToEOAParams;
+};
+
+/** @internal */
+export type CreditUserOperationBody$Outbound =
+  | CreditBorrowParams$Outbound
+  | CreditRepayParams$Outbound
+  | CreditSupplyParams$Outbound
+  | CreditWithdrawParams$Outbound
+  | EarnSwapParams$Outbound
+  | EarnTransferFromEOAParams$Outbound
+  | EarnTransferToEOAParams$Outbound;
+
+/** @internal */
+export const CreditUserOperationBody$outboundSchema: z.ZodType<
+  CreditUserOperationBody$Outbound,
+  z.ZodTypeDef,
+  CreditUserOperationBody
+> = z.union([
+  CreditBorrowParams$outboundSchema,
+  CreditRepayParams$outboundSchema,
+  CreditSupplyParams$outboundSchema,
+  CreditWithdrawParams$outboundSchema,
+  EarnSwapParams$outboundSchema,
+  EarnTransferFromEOAParams$outboundSchema,
+  EarnTransferToEOAParams$outboundSchema,
+]);
+
+export function creditUserOperationBodyToJSON(
+  creditUserOperationBody: CreditUserOperationBody,
+): string {
+  return JSON.stringify(
+    CreditUserOperationBody$outboundSchema.parse(creditUserOperationBody),
+  );
+}
+
+/** @internal */
+export type CreditUserOperation$Outbound = {
+  body:
+    | CreditBorrowParams$Outbound
+    | CreditRepayParams$Outbound
+    | CreditSupplyParams$Outbound
+    | CreditWithdrawParams$Outbound
+    | EarnSwapParams$Outbound
+    | EarnTransferFromEOAParams$Outbound
+    | EarnTransferToEOAParams$Outbound;
+};
+
+/** @internal */
+export const CreditUserOperation$outboundSchema: z.ZodType<
+  CreditUserOperation$Outbound,
+  z.ZodTypeDef,
+  CreditUserOperation
+> = z.object({
+  body: z.union([
+    CreditBorrowParams$outboundSchema,
+    CreditRepayParams$outboundSchema,
+    CreditSupplyParams$outboundSchema,
+    CreditWithdrawParams$outboundSchema,
+    EarnSwapParams$outboundSchema,
+    EarnTransferFromEOAParams$outboundSchema,
+    EarnTransferToEOAParams$outboundSchema,
+  ]),
+});
+
+export function creditUserOperationToJSON(
+  creditUserOperation: CreditUserOperation,
+): string {
+  return JSON.stringify(
+    CreditUserOperation$outboundSchema.parse(creditUserOperation),
+  );
+}