@compass-labs/api-sdk 0.5.47 → 0.5.49

package/docs/sdks/swap/README.md

@@ -0,0 +1,99 @@
+# Swap
+(*swap*)
+
+## Overview
+
+### Available Operations
+
+* [odos](#odos) - Odos Swap
+
+## odos
+
+Swap between two tokens using Odos Smart Order Routing.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `OdosRouter`
+</Info>
+
+
+### 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.swap.odos({
+    tokenIn: "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
+    tokenOut: "0xdac17f958d2ee523a2206206994597c13d831ec7",
+    amount: 1.5,
+    maxSlippagePercent: 0.5,
+    chain: "ethereum:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { swapOdos } from "@compass-labs/api-sdk/funcs/swapOdos.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 swapOdos(compassApiSDK, {
+    tokenIn: "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
+    tokenOut: "0xdac17f958d2ee523a2206206994597c13d831ec7",
+    amount: 1.5,
+    maxSlippagePercent: 0.5,
+    chain: "ethereum:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("swapOdos failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.OdosSwapRequest](../../models/components/odosswaprequest.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.TxResponse](../../models/components/txresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |

package/examples/{aaveV3Rate.example.ts → aaveV3AaveSupportedTokens.example.ts}

@@ -6,7 +6,7 @@
  * Example usage of the @compass-labs/api-sdk SDK
  *
  * To run this example from the examples directory:
- * npm run build && npx tsx aaveV3Rate.ts
+ * npm run build && npx tsx aaveV3AaveSupportedTokens.ts
  */
 
 import { CompassApiSDK } from "@compass-labs/api-sdk";
@@ -16,7 +16,7 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function main() {
-  const result = await compassApiSDK.rate({});
+  const result = await compassApiSDK.aaveSupportedTokens({});
 
   console.log(result);
 }

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.5.47",
+  "version": "0.5.49",
   "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.5.47",
+  "version": "0.5.49",
   "author": "royalnine",
   "type": "module",
   "bin": {

package/src/funcs/aaveV3AaveSupportedTokens.ts

@@ -0,0 +1,182 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeFormQuery } 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 * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Aave Supported Tokens
+ *
+ * @remarks
+ * Returns the list of supported tokens on Aave for the specified network, along
+ * with key metadata.
+ *
+ * For each token, the response includes:
+ * - The symbol and contract address.
+ * - Whether the token is currently enabled for supplying (depositing).
+ * - Whether it is enabled for borrowing.
+ */
+export function aaveV3AaveSupportedTokens(
+  client: CompassApiSDKCore,
+  request: operations.AaveAaveSupportedTokensRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.AaveSupportedTokensResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: operations.AaveAaveSupportedTokensRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.AaveSupportedTokensResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.AaveAaveSupportedTokensRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v0/aave/aave_supported_tokens/get")();
+
+  const query = encodeFormQuery({
+    "block": payload.block,
+    "chain": payload.chain,
+  });
+
+  const headers = new Headers(compactMap({
+    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: "aave_aave_supported_tokens",
+    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: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    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.AaveSupportedTokensResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.AaveSupportedTokensResponse$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 }];
+}

package/src/funcs/swapOdos.ts

@@ -0,0 +1,176 @@
+/*
+ * 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";
+
+/**
+ * Odos Swap
+ *
+ * @remarks
+ * Swap between two tokens using Odos Smart Order Routing.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `OdosRouter`
+ * </Info>
+ */
+export function swapOdos(
+  client: CompassApiSDKCore,
+  request: components.OdosSwapRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.TxResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.OdosSwapRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.TxResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.OdosSwapRequest$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/swap/odos")();
+
+  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: "swap_odos",
+    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,
+    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.TxResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.TxResponse$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 }];
+}

package/src/lib/config.ts

@@ -61,8 +61,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
-  sdkVersion: "0.5.47",
-  genVersion: "2.656.9",
+  sdkVersion: "0.5.49",
+  genVersion: "2.657.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.5.47 2.656.9 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 0.5.49 2.657.1 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.5.47",
+    currentVersion: "0.5.49",
   },
 });
 

package/src/mcp-server/server.ts

@@ -13,6 +13,7 @@ import {
 } from "./resources.js";
 import { MCPScope } from "./scopes.js";
 import { createRegisterTool } from "./tools.js";
+import { tool$aaveV3AaveSupportedTokens } from "./tools/aaveV3AaveSupportedTokens.js";
 import { tool$aaveV3AvgRate } from "./tools/aaveV3AvgRate.js";
 import { tool$aaveV3Borrow } from "./tools/aaveV3Borrow.js";
 import { tool$aaveV3HistoricalTransactions } from "./tools/aaveV3HistoricalTransactions.js";
@@ -65,6 +66,7 @@ import { tool$skyPosition } from "./tools/skyPosition.js";
 import { tool$skySell } from "./tools/skySell.js";
 import { tool$skyWithdraw } from "./tools/skyWithdraw.js";
 import { tool$smartAccountAccountBatchedUserOperations } from "./tools/smartAccountAccountBatchedUserOperations.js";
+import { tool$swapOdos } from "./tools/swapOdos.js";
 import { tool$tokenAddress } from "./tools/tokenAddress.js";
 import { tool$tokenBalance } from "./tools/tokenBalance.js";
 import { tool$tokenPrice } from "./tools/tokenPrice.js";
@@ -101,7 +103,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "CompassApiSDK",
-    version: "0.5.47",
+    version: "0.5.49",
   });
 
   const client = new CompassApiSDKCore({
@@ -131,6 +133,7 @@ export function createMCPServer(deps: {
   const register = { tool, resource, resourceTemplate, prompt };
   void register; // suppress unused warnings
 
+  tool(tool$aaveV3AaveSupportedTokens);
   tool(tool$aaveV3Rate);
   tool(tool$aaveV3AvgRate);
   tool(tool$aaveV3StdRate);
@@ -201,6 +204,7 @@ export function createMCPServer(deps: {
   tool(tool$pendleRedeemYield);
   tool(tool$pendleAddLiquidity);
   tool(tool$pendleRemoveLiquidity);
+  tool(tool$swapOdos);
   tool(tool$transactionBundlerBundlerAuthorization);
   tool(tool$transactionBundlerBundlerExecute);
   tool(tool$transactionBundlerBundlerAaveLoop);

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

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { aaveV3AaveSupportedTokens } from "../../funcs/aaveV3AaveSupportedTokens.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.AaveAaveSupportedTokensRequest$inboundSchema,
+};
+
+export const tool$aaveV3AaveSupportedTokens: ToolDefinition<typeof args> = {
+  name: "aave-v3-aave-supported-tokens",
+  description: `Aave Supported Tokens
+
+Returns the list of supported tokens on Aave for the specified network, along
+with key metadata.
+
+For each token, the response includes:
+- The symbol and contract address.
+- Whether the token is currently enabled for supplying (depositing).
+- Whether it is enabled for borrowing.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await aaveV3AaveSupportedTokens(
+      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);
+  },
+};

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

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { swapOdos } from "../../funcs/swapOdos.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: components.OdosSwapRequest$inboundSchema,
+};
+
+export const tool$swapOdos: ToolDefinition<typeof args> = {
+  name: "swap-odos",
+  description: `Odos Swap
+
+Swap between two tokens using Odos Smart Order Routing.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - \`OdosRouter\`
+</Info>
+`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await swapOdos(
+      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);
+  },
+};