@compass-labs/api-sdk 2.0.0 → 2.1.0

package/src/models/components/createaccountresponse.ts

@@ -15,14 +15,14 @@ import {
 } from "./unsignedtransaction.js";
 
 /**
- * Response containing unsigned transaction to create compass account.
+ * Response containing unsigned transaction to create compass Earn account.
  */
 export type CreateAccountResponse = {
   transaction: UnsignedTransaction;
   /**
-   * Predicted address of the compass account that will be deployed
+   * Predicted address of the compass earn account that will be deployed
    */
-  predictedSafeAddress: string;
+  earnAccountAddress: string;
 };
 
 /** @internal */
@@ -32,16 +32,16 @@ export const CreateAccountResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   transaction: UnsignedTransaction$inboundSchema,
-  predicted_safe_address: z.string(),
+  earn_account_address: z.string(),
 }).transform((v) => {
   return remap$(v, {
-    "predicted_safe_address": "predictedSafeAddress",
+    "earn_account_address": "earnAccountAddress",
   });
 });
 /** @internal */
 export type CreateAccountResponse$Outbound = {
   transaction: UnsignedTransaction$Outbound;
-  predicted_safe_address: string;
+  earn_account_address: string;
 };
 
 /** @internal */
@@ -51,10 +51,10 @@ export const CreateAccountResponse$outboundSchema: z.ZodType<
   CreateAccountResponse
 > = z.object({
   transaction: UnsignedTransaction$outboundSchema,
-  predictedSafeAddress: z.string(),
+  earnAccountAddress: z.string(),
 }).transform((v) => {
   return remap$(v, {
-    predictedSafeAddress: "predicted_safe_address",
+    earnAccountAddress: "earn_account_address",
   });
 });
 

package/src/models/components/earnmanagerequest.ts

@@ -0,0 +1,225 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AaveVenue,
+  AaveVenue$inboundSchema,
+  AaveVenue$Outbound,
+  AaveVenue$outboundSchema,
+} from "./aavevenue.js";
+import { Chain, Chain$inboundSchema, Chain$outboundSchema } from "./chain.js";
+import {
+  Fee,
+  Fee$inboundSchema,
+  Fee$Outbound,
+  Fee$outboundSchema,
+} from "./fee.js";
+import {
+  VaultVenue,
+  VaultVenue$inboundSchema,
+  VaultVenue$Outbound,
+  VaultVenue$outboundSchema,
+} from "./vaultvenue.js";
+
+/**
+ * The earn venue.
+ */
+export type Venue =
+  | (AaveVenue & { type: "AAVE" })
+  | (VaultVenue & { type: "VAULT" });
+
+/**
+ * Whether you are depositing into or withdrawing from the given Earn `venue`.
+ */
+export const EarnManageRequestAction = {
+  Deposit: "DEPOSIT",
+  Withdraw: "WITHDRAW",
+} as const;
+/**
+ * Whether you are depositing into or withdrawing from the given Earn `venue`.
+ */
+export type EarnManageRequestAction = ClosedEnum<
+  typeof EarnManageRequestAction
+>;
+
+export type EarnManageRequest = {
+  /**
+   * The owner's wallet address.
+   */
+  owner: string;
+  /**
+   * The chain to use.
+   */
+  chain: Chain;
+  /**
+   * The earn venue.
+   */
+  venue: (AaveVenue & { type: "AAVE" }) | (VaultVenue & { type: "VAULT" });
+  /**
+   * Whether you are depositing into or withdrawing from the given Earn `venue`.
+   */
+  action: EarnManageRequestAction;
+  /**
+   * Amount of the underlying asset to act on (deposit or withdraw). For VAULT, this is the vault’s underlying token; for AAVE, this is the Aave reserve asset. Provide as a decimal in token units (not wei); must be > 0.
+   */
+  amount?: any | undefined;
+  /**
+   * Optionally request gas sponsorship. If set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).
+   */
+  gasSponsorship?: boolean | undefined;
+  /**
+   * Optional fee configuration. If provided, a fee will be applied to the transaction amount and sent to the specified recipient address. The fee can be specified as a percentage of the transaction amount or as a fixed token amount.
+   */
+  fee?: Fee | null | undefined;
+};
+
+/** @internal */
+export const Venue$inboundSchema: z.ZodType<Venue, z.ZodTypeDef, unknown> = z
+  .union([
+    AaveVenue$inboundSchema.and(
+      z.object({ type: z.literal("AAVE") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    VaultVenue$inboundSchema.and(
+      z.object({ type: z.literal("VAULT") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+  ]);
+/** @internal */
+export type Venue$Outbound =
+  | (AaveVenue$Outbound & { type: "AAVE" })
+  | (VaultVenue$Outbound & { type: "VAULT" });
+
+/** @internal */
+export const Venue$outboundSchema: z.ZodType<
+  Venue$Outbound,
+  z.ZodTypeDef,
+  Venue
+> = z.union([
+  AaveVenue$outboundSchema.and(
+    z.object({ type: z.literal("AAVE") }).transform((v) => ({ type: v.type })),
+  ),
+  VaultVenue$outboundSchema.and(
+    z.object({ type: z.literal("VAULT") }).transform((v) => ({ type: v.type })),
+  ),
+]);
+
+export function venueToJSON(venue: Venue): string {
+  return JSON.stringify(Venue$outboundSchema.parse(venue));
+}
+export function venueFromJSON(
+  jsonString: string,
+): SafeParseResult<Venue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Venue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Venue' from JSON`,
+  );
+}
+
+/** @internal */
+export const EarnManageRequestAction$inboundSchema: z.ZodNativeEnum<
+  typeof EarnManageRequestAction
+> = z.nativeEnum(EarnManageRequestAction);
+/** @internal */
+export const EarnManageRequestAction$outboundSchema: z.ZodNativeEnum<
+  typeof EarnManageRequestAction
+> = EarnManageRequestAction$inboundSchema;
+
+/** @internal */
+export const EarnManageRequest$inboundSchema: z.ZodType<
+  EarnManageRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  owner: z.string(),
+  chain: Chain$inboundSchema,
+  venue: z.union([
+    AaveVenue$inboundSchema.and(
+      z.object({ type: z.literal("AAVE") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    VaultVenue$inboundSchema.and(
+      z.object({ type: z.literal("VAULT") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+  ]),
+  action: EarnManageRequestAction$inboundSchema,
+  amount: z.any().optional(),
+  gas_sponsorship: z.boolean().optional(),
+  fee: z.nullable(Fee$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "gas_sponsorship": "gasSponsorship",
+  });
+});
+/** @internal */
+export type EarnManageRequest$Outbound = {
+  owner: string;
+  chain: string;
+  venue:
+    | (AaveVenue$Outbound & { type: "AAVE" })
+    | (VaultVenue$Outbound & { type: "VAULT" });
+  action: string;
+  amount?: any | undefined;
+  gas_sponsorship?: boolean | undefined;
+  fee?: Fee$Outbound | null | undefined;
+};
+
+/** @internal */
+export const EarnManageRequest$outboundSchema: z.ZodType<
+  EarnManageRequest$Outbound,
+  z.ZodTypeDef,
+  EarnManageRequest
+> = z.object({
+  owner: z.string(),
+  chain: Chain$outboundSchema,
+  venue: z.union([
+    AaveVenue$outboundSchema.and(
+      z.object({ type: z.literal("AAVE") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    VaultVenue$outboundSchema.and(
+      z.object({ type: z.literal("VAULT") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+  ]),
+  action: EarnManageRequestAction$outboundSchema,
+  amount: z.any().optional(),
+  gasSponsorship: z.boolean().optional(),
+  fee: z.nullable(Fee$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    gasSponsorship: "gas_sponsorship",
+  });
+});
+
+export function earnManageRequestToJSON(
+  earnManageRequest: EarnManageRequest,
+): string {
+  return JSON.stringify(
+    EarnManageRequest$outboundSchema.parse(earnManageRequest),
+  );
+}
+export function earnManageRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<EarnManageRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EarnManageRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EarnManageRequest' from JSON`,
+  );
+}

package/src/models/components/{earndepositresponse.ts → earnmanageresponse.ts}

@@ -20,14 +20,14 @@ import {
   UnsignedTransaction$outboundSchema,
 } from "./unsignedtransaction.js";
 
-export type EarnDepositResponse = {
+export type EarnManageResponse = {
   transaction: UnsignedTransaction | null;
   eip712: BatchedSafeOperationsResponseOutput | null;
 };
 
 /** @internal */
-export const EarnDepositResponse$inboundSchema: z.ZodType<
-  EarnDepositResponse,
+export const EarnManageResponse$inboundSchema: z.ZodType<
+  EarnManageResponse,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -39,16 +39,16 @@ export const EarnDepositResponse$inboundSchema: z.ZodType<
   });
 });
 /** @internal */
-export type EarnDepositResponse$Outbound = {
+export type EarnManageResponse$Outbound = {
   transaction: UnsignedTransaction$Outbound | null;
   eip_712: BatchedSafeOperationsResponseOutput$Outbound | null;
 };
 
 /** @internal */
-export const EarnDepositResponse$outboundSchema: z.ZodType<
-  EarnDepositResponse$Outbound,
+export const EarnManageResponse$outboundSchema: z.ZodType<
+  EarnManageResponse$Outbound,
   z.ZodTypeDef,
-  EarnDepositResponse
+  EarnManageResponse
 > = z.object({
   transaction: z.nullable(UnsignedTransaction$outboundSchema),
   eip712: z.nullable(BatchedSafeOperationsResponseOutput$outboundSchema),
@@ -58,19 +58,19 @@ export const EarnDepositResponse$outboundSchema: z.ZodType<
   });
 });
 
-export function earnDepositResponseToJSON(
-  earnDepositResponse: EarnDepositResponse,
+export function earnManageResponseToJSON(
+  earnManageResponse: EarnManageResponse,
 ): string {
   return JSON.stringify(
-    EarnDepositResponse$outboundSchema.parse(earnDepositResponse),
+    EarnManageResponse$outboundSchema.parse(earnManageResponse),
   );
 }
-export function earnDepositResponseFromJSON(
+export function earnManageResponseFromJSON(
   jsonString: string,
-): SafeParseResult<EarnDepositResponse, SDKValidationError> {
+): SafeParseResult<EarnManageResponse, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => EarnDepositResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'EarnDepositResponse' from JSON`,
+    (x) => EarnManageResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EarnManageResponse' from JSON`,
   );
 }

package/src/models/components/earnpositionresponse.ts

@@ -0,0 +1,165 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AavePosition,
+  AavePosition$inboundSchema,
+  AavePosition$Outbound,
+  AavePosition$outboundSchema,
+} from "./aaveposition.js";
+import {
+  CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition,
+  CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inboundSchema,
+  CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$Outbound,
+  CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$outboundSchema,
+} from "./compassapibackendv2modelsearnreadresponsepositionsvaultposition.js";
+
+/**
+ * The user's earn position.
+ */
+export type PositionUnion =
+  | (CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition & {
+    type: "VAULT";
+  })
+  | (AavePosition & { type: "AAVE" });
+
+/**
+ * Response model for a single earn position.
+ */
+export type EarnPositionResponse = {
+  /**
+   * The user's earn position.
+   */
+  position:
+    | (CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition & {
+      type: "VAULT";
+    })
+    | (AavePosition & { type: "AAVE" });
+};
+
+/** @internal */
+export const PositionUnion$inboundSchema: z.ZodType<
+  PositionUnion,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inboundSchema
+    .and(
+      z.object({ type: z.literal("VAULT") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+  AavePosition$inboundSchema.and(
+    z.object({ type: z.literal("AAVE") }).transform((v) => ({ type: v.type })),
+  ),
+]);
+/** @internal */
+export type PositionUnion$Outbound =
+  | (
+    & CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$Outbound
+    & { type: "VAULT" }
+  )
+  | (AavePosition$Outbound & { type: "AAVE" });
+
+/** @internal */
+export const PositionUnion$outboundSchema: z.ZodType<
+  PositionUnion$Outbound,
+  z.ZodTypeDef,
+  PositionUnion
+> = z.union([
+  CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$outboundSchema
+    .and(
+      z.object({ type: z.literal("VAULT") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+  AavePosition$outboundSchema.and(
+    z.object({ type: z.literal("AAVE") }).transform((v) => ({ type: v.type })),
+  ),
+]);
+
+export function positionUnionToJSON(positionUnion: PositionUnion): string {
+  return JSON.stringify(PositionUnion$outboundSchema.parse(positionUnion));
+}
+export function positionUnionFromJSON(
+  jsonString: string,
+): SafeParseResult<PositionUnion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PositionUnion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PositionUnion' from JSON`,
+  );
+}
+
+/** @internal */
+export const EarnPositionResponse$inboundSchema: z.ZodType<
+  EarnPositionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  position: z.union([
+    CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inboundSchema
+      .and(
+        z.object({ type: z.literal("VAULT") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+    AavePosition$inboundSchema.and(
+      z.object({ type: z.literal("AAVE") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+  ]),
+});
+/** @internal */
+export type EarnPositionResponse$Outbound = {
+  position:
+    | (
+      & CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$Outbound
+      & { type: "VAULT" }
+    )
+    | (AavePosition$Outbound & { type: "AAVE" });
+};
+
+/** @internal */
+export const EarnPositionResponse$outboundSchema: z.ZodType<
+  EarnPositionResponse$Outbound,
+  z.ZodTypeDef,
+  EarnPositionResponse
+> = z.object({
+  position: z.union([
+    CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$outboundSchema
+      .and(
+        z.object({ type: z.literal("VAULT") }).transform((v) => ({
+          type: v.type,
+        })),
+      ),
+    AavePosition$outboundSchema.and(
+      z.object({ type: z.literal("AAVE") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+  ]),
+});
+
+export function earnPositionResponseToJSON(
+  earnPositionResponse: EarnPositionResponse,
+): string {
+  return JSON.stringify(
+    EarnPositionResponse$outboundSchema.parse(earnPositionResponse),
+  );
+}
+export function earnPositionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<EarnPositionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EarnPositionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EarnPositionResponse' from JSON`,
+  );
+}

package/src/models/components/earntransferrequest.ts

@@ -16,14 +16,14 @@ import { Chain, Chain$inboundSchema, Chain$outboundSchema } from "./chain.js";
 export type EarnTransferRequestAmount = number | string;
 
 /**
- * Whether you are funding or withdrawing from your earn account.
+ * Whether you are depositing to or withdrawing from your earn account.
  */
 export const EarnTransferRequestAction = {
-  Fund: "FUND",
+  Deposit: "DEPOSIT",
   Withdraw: "WITHDRAW",
 } as const;
 /**
- * Whether you are funding or withdrawing from your earn account.
+ * Whether you are depositing to or withdrawing from your earn account.
  */
 export type EarnTransferRequestAction = ClosedEnum<
   typeof EarnTransferRequestAction
@@ -47,7 +47,7 @@ export type EarnTransferRequest = {
    */
   amount: number | string;
   /**
-   * Whether you are funding or withdrawing from your earn account.
+   * Whether you are depositing to or withdrawing from your earn account.
    */
   action: EarnTransferRequestAction;
   /**
@@ -55,7 +55,7 @@ export type EarnTransferRequest = {
    */
   gasSponsorship?: boolean | undefined;
   /**
-   * The address of the wallet which will send the transaction. This only needs to be set when 'action' is 'FUND' and `gas_sponsorship` is `true`.
+   * The address of the wallet which will send the transaction. This only needs to be set when `action` is 'DEPOSIT' and `gas_sponsorship` is `true`.
    */
   spender?: string | null | undefined;
 };

package/src/models/components/fee.ts

@@ -0,0 +1,112 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens).
+ */
+export type FeeAmount = number | string;
+
+/**
+ * The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount) or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens).
+ */
+export const Denomination = {
+  Percentage: "PERCENTAGE",
+  Fixed: "FIXED",
+} as const;
+/**
+ * The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount) or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens).
+ */
+export type Denomination = ClosedEnum<typeof Denomination>;
+
+export type Fee = {
+  /**
+   * The wallet address that will receive the fee.
+   */
+  recipient: string;
+  /**
+   * The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens).
+   */
+  amount: number | string;
+  /**
+   * The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount) or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens).
+   */
+  denomination?: Denomination | undefined;
+};
+
+/** @internal */
+export const FeeAmount$inboundSchema: z.ZodType<
+  FeeAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+/** @internal */
+export type FeeAmount$Outbound = number | string;
+
+/** @internal */
+export const FeeAmount$outboundSchema: z.ZodType<
+  FeeAmount$Outbound,
+  z.ZodTypeDef,
+  FeeAmount
+> = z.union([z.number(), z.string()]);
+
+export function feeAmountToJSON(feeAmount: FeeAmount): string {
+  return JSON.stringify(FeeAmount$outboundSchema.parse(feeAmount));
+}
+export function feeAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<FeeAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FeeAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FeeAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const Denomination$inboundSchema: z.ZodNativeEnum<typeof Denomination> =
+  z.nativeEnum(Denomination);
+/** @internal */
+export const Denomination$outboundSchema: z.ZodNativeEnum<typeof Denomination> =
+  Denomination$inboundSchema;
+
+/** @internal */
+export const Fee$inboundSchema: z.ZodType<Fee, z.ZodTypeDef, unknown> = z
+  .object({
+    recipient: z.string(),
+    amount: z.union([z.number(), z.string()]),
+    denomination: Denomination$inboundSchema.optional(),
+  });
+/** @internal */
+export type Fee$Outbound = {
+  recipient: string;
+  amount: number | string;
+  denomination?: string | undefined;
+};
+
+/** @internal */
+export const Fee$outboundSchema: z.ZodType<Fee$Outbound, z.ZodTypeDef, Fee> = z
+  .object({
+    recipient: z.string(),
+    amount: z.union([z.number(), z.string()]),
+    denomination: Denomination$outboundSchema.optional(),
+  });
+
+export function feeToJSON(fee: Fee): string {
+  return JSON.stringify(Fee$outboundSchema.parse(fee));
+}
+export function feeFromJSON(
+  jsonString: string,
+): SafeParseResult<Fee, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Fee$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Fee' from JSON`,
+  );
+}