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

package/docs/models/components/v2bundlerequest.md

@@ -0,0 +1,52 @@
+# V2BundleRequest
+
+Request model for bundling multiple V2 earn actions into a single Safe
+transaction.
+
+This endpoint allows combining multiple actions (swaps, vault deposits/withdrawals,
+Aave deposits/withdrawals) into a single atomic transaction executed Compass Account.
+
+Example use case: Swap USDC to AUSD, then deposit AUSD into a vault - all in one tx.
+
+## Example Usage
+
+```typescript
+import { V2BundleRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: V2BundleRequest = {
+  owner: "0x0B8A11cF0679F163087802c4428F640cA7C89926",
+  chain: "ethereum",
+  actions: [
+    {
+      body: {
+        actionType: "V2_SWAP",
+        tokenIn: "USDC",
+        tokenOut: "AUSD",
+        amountIn: "100",
+        slippage: "0.5",
+      },
+    },
+    {
+      body: {
+        actionType: "V2_MANAGE",
+        venue: {
+          type: "VAULT",
+          vaultAddress: "0x1B4cd53a1A8e5F50aB6320EF34E5fB4D3df7B6f6",
+        },
+        action: "DEPOSIT",
+        amount: "ALL",
+      },
+    },
+  ],
+  gasSponsorship: false,
+};
+```
+
+## Fields
+
+| Field                                                                                                                          | Type                                                                                                                           | Required                                                                                                                       | Description                                                                                                                    | Example                                                                                                                        |
+| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
+| `owner`                                                                                                                        | *string*                                                                                                                       | :heavy_check_mark:                                                                                                             | The owner's wallet address that controls the Earn Account (Safe).                                                              |                                                                                                                                |
+| `chain`                                                                                                                        | [components.Chain](../../models/components/chain.md)                                                                           | :heavy_check_mark:                                                                                                             | The chain to use.                                                                                                              |                                                                                                                                |
+| `actions`                                                                                                                      | [components.V2UserOperation](../../models/components/v2useroperation.md)[]                                                     | :heavy_check_mark:                                                                                                             | List of actions to bundle. Actions are executed in order.                                                                      |                                                                                                                                |
+| `gasSponsorship`                                                                                                               | *boolean*                                                                                                                      | :heavy_minus_sign:                                                                                                             | If true, returns EIP-712 typed data for gas sponsorship. The owner must sign this data and submit to /gas_sponsorship/prepare. | false                                                                                                                          |

package/docs/models/components/v2bundleresponse.md

@@ -0,0 +1,24 @@
+# V2BundleResponse
+
+Response model for V2 bundle execution.
+
+Returns either an unsigned transaction (for direct execution) or EIP-712 typed data
+(for gas-sponsored execution).
+
+## Example Usage
+
+```typescript
+import { V2BundleResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: V2BundleResponse = {
+  actionsCount: 314088,
+};
+```
+
+## Fields
+
+| Field                                                                                                                                      | Type                                                                                                                                       | Required                                                                                                                                   | Description                                                                                                                                |
+| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| `transaction`                                                                                                                              | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)                                                           | :heavy_minus_sign:                                                                                                                         | Unsigned transaction for direct execution by the owner. Present when gas_sponsorship=false.                                                |
+| `eip712`                                                                                                                                   | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md)                           | :heavy_minus_sign:                                                                                                                         | EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true. Owner must sign and submit to /gas_sponsorship/prepare. |
+| `actionsCount`                                                                                                                             | *number*                                                                                                                                   | :heavy_check_mark:                                                                                                                         | Number of individual transactions bundled in this execution.                                                                               |

package/docs/models/components/v2useroperation.md

@@ -0,0 +1,27 @@
+# V2UserOperation
+
+A single operation in a V2 bundle.
+
+## Example Usage
+
+```typescript
+import { V2UserOperation } from "@compass-labs/api-sdk/models/components";
+
+let value: V2UserOperation = {
+  body: {
+    actionType: "V2_MANAGE",
+    venue: {
+      type: "VAULT",
+      vaultAddress: "<value>",
+    },
+    action: "WITHDRAW",
+    amount: 6398.2,
+  },
+};
+```
+
+## Fields
+
+| Field                            | Type                             | Required                         | Description                      |
+| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
+| `body`                           | *components.V2UserOperationBody* | :heavy_check_mark:               | N/A                              |

package/docs/models/components/v2useroperationbody.md

@@ -0,0 +1,31 @@
+# V2UserOperationBody
+
+
+## Supported Types
+
+### `components.EarnManageParams`
+
+```typescript
+const value: components.EarnManageParams = {
+  actionType: "V2_MANAGE",
+  venue: {
+    type: "VAULT",
+    vaultAddress: "<value>",
+  },
+  action: "WITHDRAW",
+  amount: 3994.36,
+};
+```
+
+### `components.EarnSwapParams`
+
+```typescript
+const value: components.EarnSwapParams = {
+  actionType: "V2_SWAP",
+  tokenIn: "<value>",
+  tokenOut: "<value>",
+  amountIn: 1543.87,
+  slippage: "0.5",
+};
+```
+

package/docs/sdks/aavev3/README.md

@@ -1,5 +1,4 @@
 # AaveV3
-(*aaveV3*)
 
 ## Overview
 

package/docs/sdks/aerodromeslipstream/README.md

@@ -1,5 +1,4 @@
 # AerodromeSlipstream
-(*aerodromeSlipstream*)
 
 ## Overview
 

package/docs/sdks/bridge/README.md

@@ -1,5 +1,4 @@
 # Bridge
-(*bridge*)
 
 ## Overview
 

package/docs/sdks/earn/README.md

@@ -1,5 +1,4 @@
 # Earn
-(*earn*)
 
 ## Overview
 
@@ -13,6 +12,7 @@
 * [earnTransfer](#earntransfer) - Transfer tokens to/from account
 * [earnManage](#earnmanage) - Manage earn position
 * [earnSwap](#earnswap) - Swap tokens within Earn Account
+* [earnBundle](#earnbundle) - Execute multiple earn actions
 
 ## earnPositions
 
@@ -537,14 +537,15 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.earn.earnManage({
-    owner: "0xe5310C39a8A8f16E6126ee6B1006bf6eD58B3A49",
-    chain: "base",
     venue: {
       type: "VAULT",
       vaultAddress: "0x7BfA7C4f149E7415b73bdeDfe609237e29CBF34A",
     },
-    action: "WITHDRAW",
+    action: "DEPOSIT",
     amount: "0.01",
+    owner: "0xe5310C39a8A8f16E6126ee6B1006bf6eD58B3A49",
+    chain: "base",
+    gasSponsorship: false,
   });
 
   console.log(result);
@@ -569,14 +570,15 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await earnEarnManage(compassApiSDK, {
-    owner: "0xe5310C39a8A8f16E6126ee6B1006bf6eD58B3A49",
-    chain: "base",
     venue: {
       type: "VAULT",
       vaultAddress: "0x7BfA7C4f149E7415b73bdeDfe609237e29CBF34A",
     },
-    action: "WITHDRAW",
+    action: "DEPOSIT",
     amount: "0.01",
+    owner: "0xe5310C39a8A8f16E6126ee6B1006bf6eD58B3A49",
+    chain: "base",
+    gasSponsorship: false,
   });
   if (res.ok) {
     const { value: result } = res;
@@ -625,12 +627,12 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.earn.earnSwap({
-    owner: "0xC1be8f91480648De355a45f3E2562811b4e2D3FF",
-    chain: "base",
     tokenIn: "USDC",
     tokenOut: "USDT",
     amountIn: "0.01",
     slippage: "0.5",
+    owner: "0xC1be8f91480648De355a45f3E2562811b4e2D3FF",
+    chain: "base",
     gasSponsorship: false,
   });
 
@@ -656,12 +658,12 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await earnEarnSwap(compassApiSDK, {
-    owner: "0xC1be8f91480648De355a45f3E2562811b4e2D3FF",
-    chain: "base",
     tokenIn: "USDC",
     tokenOut: "USDT",
     amountIn: "0.01",
     slippage: "0.5",
+    owner: "0xC1be8f91480648De355a45f3E2562811b4e2D3FF",
+    chain: "base",
     gasSponsorship: false,
   });
   if (res.ok) {
@@ -690,6 +692,141 @@ run();
 
 ### Errors
 
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## earnBundle
+
+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.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_earn_bundle" method="post" path="/v2/earn/bundle" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.earn.earnBundle({
+    owner: "0x0B8A11cF0679F163087802c4428F640cA7C89926",
+    chain: "ethereum",
+    actions: [
+      {
+        body: {
+          actionType: "V2_SWAP",
+          tokenIn: "USDC",
+          tokenOut: "AUSD",
+          amountIn: "100",
+          slippage: "0.5",
+        },
+      },
+      {
+        body: {
+          actionType: "V2_MANAGE",
+          venue: {
+            type: "VAULT",
+            vaultAddress: "0x1B4cd53a1A8e5F50aB6320EF34E5fB4D3df7B6f6",
+          },
+          action: "DEPOSIT",
+          amount: "ALL",
+        },
+      },
+    ],
+    gasSponsorship: false,
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { earnEarnBundle } from "@compass-labs/api-sdk/funcs/earnEarnBundle.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await earnEarnBundle(compassApiSDK, {
+    owner: "0x0B8A11cF0679F163087802c4428F640cA7C89926",
+    chain: "ethereum",
+    actions: [
+      {
+        body: {
+          actionType: "V2_SWAP",
+          tokenIn: "USDC",
+          tokenOut: "AUSD",
+          amountIn: "100",
+          slippage: "0.5",
+        },
+      },
+      {
+        body: {
+          actionType: "V2_MANAGE",
+          venue: {
+            type: "VAULT",
+            vaultAddress: "0x1B4cd53a1A8e5F50aB6320EF34E5fB4D3df7B6f6",
+          },
+          action: "DEPOSIT",
+          amount: "ALL",
+        },
+      },
+    ],
+    gasSponsorship: false,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("earnEarnBundle failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.V2BundleRequest](../../models/components/v2bundlerequest.md)                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.V2BundleResponse](../../models/components/v2bundleresponse.md)\>**
+
+### Errors
+
 | Error Type                 | Status Code                | Content Type               |
 | -------------------------- | -------------------------- | -------------------------- |
 | errors.HTTPValidationError | 422                        | application/json           |

package/docs/sdks/erc4626vaults/README.md

@@ -1,5 +1,4 @@
-# Erc4626Vaults
-(*erc4626Vaults*)
+# ERC4626Vaults
 
 ## Overview
 

package/docs/sdks/ethena/README.md

@@ -1,5 +1,4 @@
 # Ethena
-(*ethena*)
 
 ## Overview
 

package/docs/sdks/gassponsorship/README.md

@@ -1,5 +1,4 @@
 # GasSponsorship
-(*gasSponsorship*)
 
 ## Overview
 

package/docs/sdks/morpho/README.md

@@ -1,5 +1,4 @@
 # Morpho
-(*morpho*)
 
 ## Overview
 

package/docs/sdks/pendle/README.md

@@ -1,5 +1,4 @@
 # Pendle
-(*pendle*)
 
 ## Overview
 

package/docs/sdks/sky/README.md

@@ -1,5 +1,4 @@
 # Sky
-(*sky*)
 
 ## Overview
 

package/docs/sdks/smartaccount/README.md

@@ -1,5 +1,4 @@
 # SmartAccount
-(*smartAccount*)
 
 ## Overview
 

package/docs/sdks/swap/README.md

@@ -1,5 +1,4 @@
 # Swap
-(*swap*)
 
 ## Overview
 

package/docs/sdks/token/README.md

@@ -1,5 +1,4 @@
 # Token
-(*token*)
 
 ## Overview
 

package/docs/sdks/transactionbundler/README.md

@@ -1,5 +1,4 @@
 # TransactionBundler
-(*transactionBundler*)
 
 ## Overview
 

package/docs/sdks/uniswapv3/README.md

@@ -1,5 +1,4 @@
 # UniswapV3
-(*uniswapV3*)
 
 ## Overview
 

package/docs/sdks/universal/README.md

@@ -1,5 +1,4 @@
 # Universal
-(*universal*)
 
 ## Overview
 

package/docs/sdks/wildcat/README.md

@@ -1,5 +1,4 @@
 # Wildcat
-(*wildcat*)
 
 ## Overview
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "2.1.14",
+  "version": "2.1.15-rc.1",
   "author": "royalnine",
   "type": "module",
   "tshy": {

package/src/funcs/earnEarnBundle.ts

@@ -0,0 +1,182 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { CompassAPISDKError } from "../models/errors/compassapisdkerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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.
+ */
+export function earnEarnBundle(
+  client: CompassApiSDKCore,
+  request: components.V2BundleRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.V2BundleResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.V2BundleRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.V2BundleResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.V2BundleRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v2/earn/bundle")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "v2_earn_bundle",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.V2BundleResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.V2BundleResponse$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}