@compass-labs/api-sdk 2.2.3 → 2.2.4

package/docs/sdks/earn/README.md

@@ -759,6 +759,16 @@ async function run() {
     owner: "0x01E62835dd7F52173546A325294762143eE4a882",
     chain: "ethereum",
     actions: [
+      {
+        body: {
+          actionType: "V2_TRANSFER_FROM_EOA",
+          token: "USDC",
+          amount: "100",
+          permit2Signature: "0x...",
+          permit2Nonce: 1706000000,
+          permit2Deadline: 1706001800,
+        },
+      },
       {
         body: {
           actionType: "V2_SWAP",
@@ -808,6 +818,16 @@ async function run() {
     owner: "0x01E62835dd7F52173546A325294762143eE4a882",
     chain: "ethereum",
     actions: [
+      {
+        body: {
+          actionType: "V2_TRANSFER_FROM_EOA",
+          token: "USDC",
+          amount: "100",
+          permit2Signature: "0x...",
+          permit2Nonce: 1706000000,
+          permit2Deadline: 1706001800,
+        },
+      },
       {
         body: {
           actionType: "V2_SWAP",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "2.2.3",
+  "version": "2.2.4",
   "author": "royalnine",
   "type": "module",
   "tshy": {

package/src/lib/config.ts

@@ -62,7 +62,7 @@ export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
   sdkVersion: "2.0.0",
-  genVersion: "2.797.1",
+  genVersion: "2.799.0",
   userAgent:
-    "speakeasy-sdk/typescript 2.0.0 2.797.1 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 2.0.0 2.799.0 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/models/components/earntransferfromeoaparams.ts

@@ -0,0 +1,112 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+/**
+ * The amount of tokens to transfer (in token units, not wei).
+ */
+export type EarnTransferFromEOAParamsAmount = number | string;
+
+/**
+ * Parameters for transferring tokens from EOA to Earn Account via Permit2.
+ *
+ * @remarks
+ *
+ * Used by multicall/bundle endpoint to pull tokens from the owner's EOA
+ * into their Earn Account (Safe) as part of an atomic bundle transaction.
+ *
+ * The owner must have:
+ * 1. Previously approved Permit2 for the token (one-time setup via /gas_sponsorship/approve_transfer)
+ * 2. Signed a Permit2 message with spender = Earn Account address
+ *
+ * The signature is obtained by first calling /v2/earn/transfer with action=DEPOSIT
+ * and gas_sponsorship=True, then signing the returned EIP-712 typed data.
+ */
+export type EarnTransferFromEOAParams = {
+  /**
+   * Action type identifier for EOA-to-Earn-Account transfer operations.
+   */
+  actionType: "V2_TRANSFER_FROM_EOA";
+  /**
+   * The token to transfer from EOA to Earn Account.
+   */
+  token: string;
+  /**
+   * The amount of tokens to transfer (in token units, not wei).
+   */
+  amount: number | string;
+  /**
+   * The EOA owner's signature of the Permit2 PermitTransferFrom typed data. Obtain this by calling /v2/earn/transfer with action=DEPOSIT and gas_sponsorship=True, then signing the returned EIP-712 data with the owner's wallet.
+   */
+  permit2Signature: string;
+  /**
+   * The nonce used in the Permit2 signature (from the signed typed data).
+   */
+  permit2Nonce: number;
+  /**
+   * The deadline timestamp used in the Permit2 signature (from the signed typed data).
+   */
+  permit2Deadline: number;
+};
+
+/** @internal */
+export type EarnTransferFromEOAParamsAmount$Outbound = number | string;
+
+/** @internal */
+export const EarnTransferFromEOAParamsAmount$outboundSchema: z.ZodType<
+  EarnTransferFromEOAParamsAmount$Outbound,
+  z.ZodTypeDef,
+  EarnTransferFromEOAParamsAmount
+> = z.union([z.number(), z.string()]);
+
+export function earnTransferFromEOAParamsAmountToJSON(
+  earnTransferFromEOAParamsAmount: EarnTransferFromEOAParamsAmount,
+): string {
+  return JSON.stringify(
+    EarnTransferFromEOAParamsAmount$outboundSchema.parse(
+      earnTransferFromEOAParamsAmount,
+    ),
+  );
+}
+
+/** @internal */
+export type EarnTransferFromEOAParams$Outbound = {
+  action_type: "V2_TRANSFER_FROM_EOA";
+  token: string;
+  amount: number | string;
+  permit2_signature: string;
+  permit2_nonce: number;
+  permit2_deadline: number;
+};
+
+/** @internal */
+export const EarnTransferFromEOAParams$outboundSchema: z.ZodType<
+  EarnTransferFromEOAParams$Outbound,
+  z.ZodTypeDef,
+  EarnTransferFromEOAParams
+> = z.object({
+  actionType: z.literal("V2_TRANSFER_FROM_EOA"),
+  token: z.string(),
+  amount: z.union([z.number(), z.string()]),
+  permit2Signature: z.string(),
+  permit2Nonce: z.number().int(),
+  permit2Deadline: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    actionType: "action_type",
+    permit2Signature: "permit2_signature",
+    permit2Nonce: "permit2_nonce",
+    permit2Deadline: "permit2_deadline",
+  });
+});
+
+export function earnTransferFromEOAParamsToJSON(
+  earnTransferFromEOAParams: EarnTransferFromEOAParams,
+): string {
+  return JSON.stringify(
+    EarnTransferFromEOAParams$outboundSchema.parse(earnTransferFromEOAParams),
+  );
+}

package/src/models/components/earntransferrequest.ts

@@ -52,7 +52,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 'DEPOSIT' and `gas_sponsorship` is `true`.
+   * The address that will call Permit2's permitTransferFrom to execute the transfer. When `action` is 'DEPOSIT' and `gas_sponsorship` is `true`: - If provided, the signature will authorize this address (typically a gas sponsor) to pull tokens. - If not provided, defaults to the Earn Account (Safe) address, allowing the transfer to be included in a bundle transaction where the Safe pulls the tokens itself.
    */
   spender?: string | null | undefined;
 };

package/src/models/components/earntransfertoeoaparams.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+/**
+ * Parameters for transferring tokens from Earn Account to EOA (withdrawal).
+ *
+ * @remarks
+ *
+ * Used by multicall/bundle endpoint to send tokens from the Earn Account (Safe) back
+ * to the owner's EOA as part of an atomic bundle transaction.
+ *
+ * No signature is required for this action since the Safe already owns the tokens and
+ * is executing the transfer as part of its own transaction.
+ */
+export type EarnTransferToEOAParams = {
+  /**
+   * Action type identifier for Earn-Account-to-EOA transfer operations.
+   */
+  actionType: "V2_TRANSFER_TO_EOA";
+  /**
+   * The token to transfer from Earn Account to EOA.
+   */
+  token: string;
+  /**
+   * The amount of tokens to transfer (in token units, not wei), or 'ALL' to transfer the entire balance.
+   */
+  amount?: any | undefined;
+};
+
+/** @internal */
+export type EarnTransferToEOAParams$Outbound = {
+  action_type: "V2_TRANSFER_TO_EOA";
+  token: string;
+  amount?: any | undefined;
+};
+
+/** @internal */
+export const EarnTransferToEOAParams$outboundSchema: z.ZodType<
+  EarnTransferToEOAParams$Outbound,
+  z.ZodTypeDef,
+  EarnTransferToEOAParams
+> = z.object({
+  actionType: z.literal("V2_TRANSFER_TO_EOA"),
+  token: z.string(),
+  amount: z.any().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    actionType: "action_type",
+  });
+});
+
+export function earnTransferToEOAParamsToJSON(
+  earnTransferToEOAParams: EarnTransferToEOAParams,
+): string {
+  return JSON.stringify(
+    EarnTransferToEOAParams$outboundSchema.parse(earnTransferToEOAParams),
+  );
+}

package/src/models/components/index.ts

@@ -90,8 +90,10 @@ export * from "./earnpositionsresponse.js";
 export * from "./earnswapparams.js";
 export * from "./earnswaprequest.js";
 export * from "./earnswapresponse.js";
+export * from "./earntransferfromeoaparams.js";
 export * from "./earntransferrequest.js";
 export * from "./earntransferresponse.js";
+export * from "./earntransfertoeoaparams.js";
 export * from "./eip712domainfield.js";
 export * from "./eip712field.js";
 export * from "./ensnameinforesponse.js";

package/src/models/components/v2bundlerequest.ts

@@ -11,6 +11,47 @@ import {
   V2UserOperation$outboundSchema,
 } from "./v2useroperation.js";
 
+/**
+ * Request to execute multiple earn actions in a single atomic transaction.
+ *
+ * @remarks
+ *
+ * ## Supported Action Types
+ *
+ * - **V2_TRANSFER_FROM_EOA**: Transfer tokens from the owner's EOA to the Earn Account
+ *   using Permit2. Requires a signed Permit2 message.
+ * - **V2_TRANSFER_TO_EOA**: Transfer tokens from the Earn Account back to the owner's EOA.
+ *   No signature required (Safe owns the tokens).
+ * - **V2_SWAP**: Swap tokens within the Earn Account using 1inch aggregator.
+ * - **V2_MANAGE**: Deposit or withdraw from DeFi venues (Aave, Morpho, Vaults, etc.)
+ *
+ * ## Using V2_TRANSFER_FROM_EOA (Deposit to Earn Account)
+ *
+ * To include a transfer from EOA in your bundle, follow these steps:
+ *
+ * 1. **One-time setup**: Approve Permit2 to spend the token by calling
+ *    `POST /v2/gas_sponsorship/approve_transfer` and executing the returned transaction.
+ *
+ * 2. **Get Permit2 signature**: Call `POST /v2/earn/transfer` with:
+ *    - `action`: "DEPOSIT"
+ *    - `gas_sponsorship`: true
+ *    - `spender`: omit this field (defaults to Safe address for bundle use)
+ *
+ *    This returns EIP-712 typed data. Sign it with the owner's wallet.
+ *
+ * 3. **Include in bundle**: Add a V2_TRANSFER_FROM_EOA action with the signature
+ *    and nonce/deadline from the typed data.
+ *
+ * The bundle will atomically: pull tokens from EOA → execute subsequent actions.
+ *
+ * ## Using V2_TRANSFER_TO_EOA (Withdraw to EOA)
+ *
+ * To transfer tokens from the Earn Account back to the owner's EOA, simply add
+ * a V2_TRANSFER_TO_EOA action to your bundle. No signature is required since
+ * the Safe already owns the tokens.
+ *
+ * Use `amount: "ALL"` to transfer the entire token balance.
+ */
 export type V2BundleRequest = {
   /**
    * The owner's wallet address that controls the Earn Account.

package/src/models/components/v2useroperation.ts

@@ -13,27 +13,52 @@ import {
   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 V2UserOperationBody = EarnManageParams | EarnSwapParams;
+export type V2UserOperationBody =
+  | EarnManageParams
+  | EarnSwapParams
+  | EarnTransferFromEOAParams
+  | EarnTransferToEOAParams;
 
 /**
  * A single operation in a V2 bundle.
  */
 export type V2UserOperation = {
-  body: EarnManageParams | EarnSwapParams;
+  body:
+    | EarnManageParams
+    | EarnSwapParams
+    | EarnTransferFromEOAParams
+    | EarnTransferToEOAParams;
 };
 
 /** @internal */
 export type V2UserOperationBody$Outbound =
   | EarnManageParams$Outbound
-  | EarnSwapParams$Outbound;
+  | EarnSwapParams$Outbound
+  | EarnTransferFromEOAParams$Outbound
+  | EarnTransferToEOAParams$Outbound;
 
 /** @internal */
 export const V2UserOperationBody$outboundSchema: z.ZodType<
   V2UserOperationBody$Outbound,
   z.ZodTypeDef,
   V2UserOperationBody
-> = z.union([EarnManageParams$outboundSchema, EarnSwapParams$outboundSchema]);
+> = z.union([
+  EarnManageParams$outboundSchema,
+  EarnSwapParams$outboundSchema,
+  EarnTransferFromEOAParams$outboundSchema,
+  EarnTransferToEOAParams$outboundSchema,
+]);
 
 export function v2UserOperationBodyToJSON(
   v2UserOperationBody: V2UserOperationBody,
@@ -45,7 +70,11 @@ export function v2UserOperationBodyToJSON(
 
 /** @internal */
 export type V2UserOperation$Outbound = {
-  body: EarnManageParams$Outbound | EarnSwapParams$Outbound;
+  body:
+    | EarnManageParams$Outbound
+    | EarnSwapParams$Outbound
+    | EarnTransferFromEOAParams$Outbound
+    | EarnTransferToEOAParams$Outbound;
 };
 
 /** @internal */
@@ -57,6 +86,8 @@ export const V2UserOperation$outboundSchema: z.ZodType<
   body: z.union([
     EarnManageParams$outboundSchema,
     EarnSwapParams$outboundSchema,
+    EarnTransferFromEOAParams$outboundSchema,
+    EarnTransferToEOAParams$outboundSchema,
   ]),
 });