@compass-labs/api-sdk 0.0.23 → 0.0.25

package/docs/sdks/transactionbatching/README.md

@@ -7,6 +7,7 @@
 
 * [authorization](#authorization) - Get EIP-7702 Authorization
 * [execute](#execute) - Execute Tx Batching
+* [aaveLoop](#aaveloop) - Execute Aave Loop Strategy
 
 ## authorization
 
@@ -129,7 +130,7 @@ async function run() {
           tokenIn: "WETH",
           tokenOut: "USDC",
           fee: "0.01",
-          amountOut: 1.5,
+          amount: 1.5,
           maxSlippagePercent: 0.5,
           wrapEth: true,
         },
@@ -177,7 +178,7 @@ async function run() {
           tokenIn: "WETH",
           tokenOut: "USDC",
           fee: "0.01",
-          amountOut: 1.5,
+          amount: 1.5,
           maxSlippagePercent: 0.5,
           wrapEth: true,
         },
@@ -213,6 +214,123 @@ run();
 
 ### Errors
 
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## aaveLoop
+
+Execute an Aave looping strategy that involves repeated supply and borrow
+operations.
+
+This endpoint creates a multicall transaction that performs a series of operations:
+1. Approves and supplies initial token
+2. For each loop:
+    - Borrows another token
+    - Swaps borrowed token back to supply token
+    - Supplies the swapped tokens
+
+The transaction must be authorized using the /authorization endpoint to prevent replay attacks.
+
+### Example Usage
+
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.transactionBatching.aaveLoop({
+    chain: "ethereum:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    signedAuthorization: {
+      nonce: 1000,
+      address: "0xcA11bde05977b3631167028862bE2a173976CA11",
+      chainId: 42161,
+      r: 4.3251085460800106e+76,
+      s: 5.471500338403868e+76,
+      yParity: 0,
+    },
+    collateralToken: "osETH",
+    borrowToken: "sDAI",
+    collateralAmount: "1000",
+    loopCount: 2,
+    maxSlippagePercent: 0.5,
+    loanToValue: 20.5,
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { transactionBatchingAaveLoop } from "@compass-labs/api-sdk/funcs/transactionBatchingAaveLoop.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 transactionBatchingAaveLoop(compassApiSDK, {
+    chain: "ethereum:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    signedAuthorization: {
+      nonce: 1000,
+      address: "0xcA11bde05977b3631167028862bE2a173976CA11",
+      chainId: 42161,
+      r: 4.3251085460800106e+76,
+      s: 5.471500338403868e+76,
+      yParity: 0,
+    },
+    collateralToken: "osETH",
+    borrowToken: "sDAI",
+    collateralAmount: "1000",
+    loopCount: 2,
+    maxSlippagePercent: 0.5,
+    loanToValue: 20.5,
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.AaveLoopRequest](../../models/components/aavelooprequest.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.UnsignedMulticallTransaction](../../models/components/unsignedmulticalltransaction.md)\>**
+
+### Errors
+
 | Error Type                 | Status Code                | Content Type               |
 | -------------------------- | -------------------------- | -------------------------- |
 | errors.HTTPValidationError | 422                        | application/json           |

package/docs/sdks/uniswapv3/README.md

@@ -472,7 +472,7 @@ async function run() {
     tokenIn: "SNX",
     tokenOut: "cbETH",
     fee: "1.0",
-    amountOut: 1.5,
+    amount: 1.5,
     maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
@@ -504,7 +504,7 @@ async function run() {
     tokenIn: "SNX",
     tokenOut: "cbETH",
     fee: "1.0",
-    amountOut: 1.5,
+    amount: 1.5,
     maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.0.23",
+  "version": "0.0.25",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.0.23",
+  "version": "0.0.25",
   "author": "royalnine",
   "type": "module",
   "bin": {

package/src/funcs/transactionBatchingAaveLoop.ts

@@ -0,0 +1,173 @@
+/*
+ * 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 { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Execute Aave Loop Strategy
+ *
+ * @remarks
+ * Execute an Aave looping strategy that involves repeated supply and borrow
+ * operations.
+ *
+ * This endpoint creates a multicall transaction that performs a series of operations:
+ * 1. Approves and supplies initial token
+ * 2. For each loop:
+ *     - Borrows another token
+ *     - Swaps borrowed token back to supply token
+ *     - Supplies the swapped tokens
+ *
+ * The transaction must be authorized using the /authorization endpoint to prevent replay attacks.
+ */
+export function transactionBatchingAaveLoop(
+  client: CompassApiSDKCore,
+  request: components.AaveLoopRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.UnsignedMulticallTransaction,
+    | errors.HTTPValidationError
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.AaveLoopRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.UnsignedMulticallTransaction,
+      | errors.HTTPValidationError
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.AaveLoopRequest$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("/v0/multicall/aave/loop")();
+
+  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 = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "multicall_aave_loop",
+    oAuth2Scopes: [],
+
+    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,
+    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.UnsignedMulticallTransaction,
+    | errors.HTTPValidationError
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.UnsignedMulticallTransaction$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -57,8 +57,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
-  sdkVersion: "0.0.23",
-  genVersion: "2.598.22",
+  sdkVersion: "0.0.25",
+  genVersion: "2.599.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.0.23 2.598.22 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 0.0.25 2.599.0 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/mcp-server/mcp-server.ts

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "0.0.23",
+    currentVersion: "0.0.25",
   },
 });
 

package/src/mcp-server/server.ts

@@ -51,6 +51,7 @@ import { tool$tokenAddress } from "./tools/tokenAddress.js";
 import { tool$tokenBalance } from "./tools/tokenBalance.js";
 import { tool$tokenPrice } from "./tools/tokenPrice.js";
 import { tool$tokenTransfer } from "./tools/tokenTransfer.js";
+import { tool$transactionBatchingAaveLoop } from "./tools/transactionBatchingAaveLoop.js";
 import { tool$transactionBatchingAuthorization } from "./tools/transactionBatchingAuthorization.js";
 import { tool$transactionBatchingExecute } from "./tools/transactionBatchingExecute.js";
 import { tool$uniswapV3LiquidityProvisionIncrease } from "./tools/uniswapV3LiquidityProvisionIncrease.js";
@@ -82,7 +83,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "CompassApiSDK",
-    version: "0.0.23",
+    version: "0.0.25",
   });
 
   const client = new CompassApiSDKCore({
@@ -170,6 +171,7 @@ export function createMCPServer(deps: {
   tool(tool$universalAllowanceSet);
   tool(tool$transactionBatchingAuthorization);
   tool(tool$transactionBatchingExecute);
+  tool(tool$transactionBatchingAaveLoop);
 
   return server;
 }

package/src/mcp-server/tools/transactionBatchingAaveLoop.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { transactionBatchingAaveLoop } from "../../funcs/transactionBatchingAaveLoop.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: components.AaveLoopRequest$inboundSchema,
+};
+
+export const tool$transactionBatchingAaveLoop: ToolDefinition<typeof args> = {
+  name: "transaction-batching-aave-loop",
+  description: `Execute Aave Loop Strategy
+
+Execute an Aave looping strategy that involves repeated supply and borrow
+operations.
+
+This endpoint creates a multicall transaction that performs a series of operations:
+1. Approves and supplies initial token
+2. For each loop:
+    - Borrows another token
+    - Swaps borrowed token back to supply token
+    - Supplies the swapped tokens
+
+The transaction must be authorized using the /authorization endpoint to prevent replay attacks.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await transactionBatchingAaveLoop(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};