@compass-labs/api-sdk 2.1.14 → 2.1.15-rc.1

package/src/models/components/v2bundleresponse.ts

@@ -0,0 +1,67 @@
+/*
+ * 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";
+
+/**
+ * Response model for V2 bundle execution.
+ *
+ * @remarks
+ *
+ * Returns either an unsigned transaction (for direct execution) or EIP-712 typed data
+ * (for gas-sponsored execution).
+ */
+export type V2BundleResponse = {
+  /**
+   * Unsigned transaction for direct execution by the owner. Present when gas_sponsorship=false.
+   */
+  transaction?: UnsignedTransaction | null | undefined;
+  /**
+   * EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true. Owner must sign and submit to /gas_sponsorship/prepare.
+   */
+  eip712?: BatchedSafeOperationsResponseOutput | null | undefined;
+  /**
+   * Number of individual transactions bundled in this execution.
+   */
+  actionsCount: number;
+};
+
+/** @internal */
+export const V2BundleResponse$inboundSchema: z.ZodType<
+  V2BundleResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transaction: z.nullable(UnsignedTransaction$inboundSchema).optional(),
+  eip_712: z.nullable(BatchedSafeOperationsResponseOutput$inboundSchema)
+    .optional(),
+  actions_count: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "eip_712": "eip712",
+    "actions_count": "actionsCount",
+  });
+});
+
+export function v2BundleResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<V2BundleResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2BundleResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2BundleResponse' from JSON`,
+  );
+}

package/src/models/components/v2useroperation.ts

@@ -0,0 +1,67 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  EarnManageParams,
+  EarnManageParams$Outbound,
+  EarnManageParams$outboundSchema,
+} from "./earnmanageparams.js";
+import {
+  EarnSwapParams,
+  EarnSwapParams$Outbound,
+  EarnSwapParams$outboundSchema,
+} from "./earnswapparams.js";
+
+export type V2UserOperationBody = EarnManageParams | EarnSwapParams;
+
+/**
+ * A single operation in a V2 bundle.
+ */
+export type V2UserOperation = {
+  body: EarnManageParams | EarnSwapParams;
+};
+
+/** @internal */
+export type V2UserOperationBody$Outbound =
+  | EarnManageParams$Outbound
+  | EarnSwapParams$Outbound;
+
+/** @internal */
+export const V2UserOperationBody$outboundSchema: z.ZodType<
+  V2UserOperationBody$Outbound,
+  z.ZodTypeDef,
+  V2UserOperationBody
+> = z.union([EarnManageParams$outboundSchema, EarnSwapParams$outboundSchema]);
+
+export function v2UserOperationBodyToJSON(
+  v2UserOperationBody: V2UserOperationBody,
+): string {
+  return JSON.stringify(
+    V2UserOperationBody$outboundSchema.parse(v2UserOperationBody),
+  );
+}
+
+/** @internal */
+export type V2UserOperation$Outbound = {
+  body: EarnManageParams$Outbound | EarnSwapParams$Outbound;
+};
+
+/** @internal */
+export const V2UserOperation$outboundSchema: z.ZodType<
+  V2UserOperation$Outbound,
+  z.ZodTypeDef,
+  V2UserOperation
+> = z.object({
+  body: z.union([
+    EarnManageParams$outboundSchema,
+    EarnSwapParams$outboundSchema,
+  ]),
+});
+
+export function v2UserOperationToJSON(
+  v2UserOperation: V2UserOperation,
+): string {
+  return JSON.stringify(V2UserOperation$outboundSchema.parse(v2UserOperation));
+}

package/src/sdk/earn.ts

@@ -3,6 +3,7 @@
  */
 
 import { earnEarnAaveTokenRates } from "../funcs/earnEarnAaveTokenRates.js";
+import { earnEarnBundle } from "../funcs/earnEarnBundle.js";
 import { earnEarnCreateAccount } from "../funcs/earnEarnCreateAccount.js";
 import { earnEarnManage } from "../funcs/earnEarnManage.js";
 import { earnEarnPositions } from "../funcs/earnEarnPositions.js";
@@ -182,4 +183,34 @@ export class Earn extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Execute multiple earn actions
+   *
+   * @remarks
+   * This endpoint allows combining multiple actions (swaps, vault
+   * deposits/withdrawals, Aave deposits/withdrawals) into a single atomic transaction
+   * executed via the Earn account).
+   *
+   * **Example Use Case:** Swap USDC to AUSD, then deposit AUSD into a vault - all in one transaction.
+   *
+   * Actions are executed in the order they are provided. Each action type has its own parameters:
+   *
+   * - **V2_SWAP**: Swapping tokens within the Earn Account
+   * - **V2_MANAGE**: Manage positions - deposit/withdraw to ERC-4626 vaults or Aave lending pool
+   *
+   * The bundled transaction can be gas-sponsored by setting `gas_sponsorship=true`.
+   * This returns EIP-712 typed data that the owner must sign and submit to
+   * `/gas_sponsorship/prepare` for execution by a gas sponsor.
+   */
+  async earnBundle(
+    request: components.V2BundleRequest,
+    options?: RequestOptions,
+  ): Promise<components.V2BundleResponse> {
+    return unwrapAsync(earnEarnBundle(
+      this,
+      request,
+      options,
+    ));
+  }
 }