@compass-labs/api-sdk 0.5.46 → 0.5.48

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.46",
-  genVersion: "2.656.5",
+  sdkVersion: "0.5.48",
+  genVersion: "2.657.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.5.46 2.656.5 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 0.5.48 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.46",
+    currentVersion: "0.5.48",
   },
 });
 

package/src/mcp-server/server.ts

@@ -65,6 +65,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 +102,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "CompassApiSDK",
-    version: "0.5.46",
+    version: "0.5.48",
   });
 
   const client = new CompassApiSDKCore({
@@ -201,6 +202,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/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);
+  },
+};

package/src/models/components/index.ts

@@ -90,6 +90,8 @@ export * from "./movement10percent.js";
 export * from "./multicallauthorizationrequest.js";
 export * from "./multicallauthorizationresponse.js";
 export * from "./multicallexecuterequest.js";
+export * from "./odosswapparams.js";
+export * from "./odosswaprequest.js";
 export * from "./openposition.js";
 export * from "./pendleaddliquidityparams.js";
 export * from "./pendleaddliquidityrequest.js";

package/src/models/components/odosswapparams.ts

@@ -0,0 +1,269 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  TokenEnum,
+  TokenEnum$inboundSchema,
+  TokenEnum$outboundSchema,
+} from "./tokenenum.js";
+
+/**
+ * The symbol or address of the token that is to be sold.
+ */
+export type OdosSwapParamsTokenIn = TokenEnum | string;
+
+/**
+ * The symbol or address of the token that is to be bought.
+ */
+export type OdosSwapParamsTokenOut = TokenEnum | string;
+
+/**
+ * The amount of token_in to be sold.
+ */
+export type OdosSwapParamsAmount = number | string;
+
+export type OdosSwapParams = {
+  actionType?: "ODOS_SWAP" | undefined;
+  /**
+   * The symbol or address of the token that is to be sold.
+   */
+  tokenIn: TokenEnum | string;
+  /**
+   * The symbol or address of the token that is to be bought.
+   */
+  tokenOut: TokenEnum | string;
+  /**
+   * The amount of token_in to be sold.
+   */
+  amount: number | string;
+  /**
+   * The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed.
+   */
+  maxSlippagePercent: number;
+};
+
+/** @internal */
+export const OdosSwapParamsTokenIn$inboundSchema: z.ZodType<
+  OdosSwapParamsTokenIn,
+  z.ZodTypeDef,
+  unknown
+> = z.union([TokenEnum$inboundSchema, z.string()]);
+
+/** @internal */
+export type OdosSwapParamsTokenIn$Outbound = string | string;
+
+/** @internal */
+export const OdosSwapParamsTokenIn$outboundSchema: z.ZodType<
+  OdosSwapParamsTokenIn$Outbound,
+  z.ZodTypeDef,
+  OdosSwapParamsTokenIn
+> = z.union([TokenEnum$outboundSchema, z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OdosSwapParamsTokenIn$ {
+  /** @deprecated use `OdosSwapParamsTokenIn$inboundSchema` instead. */
+  export const inboundSchema = OdosSwapParamsTokenIn$inboundSchema;
+  /** @deprecated use `OdosSwapParamsTokenIn$outboundSchema` instead. */
+  export const outboundSchema = OdosSwapParamsTokenIn$outboundSchema;
+  /** @deprecated use `OdosSwapParamsTokenIn$Outbound` instead. */
+  export type Outbound = OdosSwapParamsTokenIn$Outbound;
+}
+
+export function odosSwapParamsTokenInToJSON(
+  odosSwapParamsTokenIn: OdosSwapParamsTokenIn,
+): string {
+  return JSON.stringify(
+    OdosSwapParamsTokenIn$outboundSchema.parse(odosSwapParamsTokenIn),
+  );
+}
+
+export function odosSwapParamsTokenInFromJSON(
+  jsonString: string,
+): SafeParseResult<OdosSwapParamsTokenIn, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OdosSwapParamsTokenIn$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OdosSwapParamsTokenIn' from JSON`,
+  );
+}
+
+/** @internal */
+export const OdosSwapParamsTokenOut$inboundSchema: z.ZodType<
+  OdosSwapParamsTokenOut,
+  z.ZodTypeDef,
+  unknown
+> = z.union([TokenEnum$inboundSchema, z.string()]);
+
+/** @internal */
+export type OdosSwapParamsTokenOut$Outbound = string | string;
+
+/** @internal */
+export const OdosSwapParamsTokenOut$outboundSchema: z.ZodType<
+  OdosSwapParamsTokenOut$Outbound,
+  z.ZodTypeDef,
+  OdosSwapParamsTokenOut
+> = z.union([TokenEnum$outboundSchema, z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OdosSwapParamsTokenOut$ {
+  /** @deprecated use `OdosSwapParamsTokenOut$inboundSchema` instead. */
+  export const inboundSchema = OdosSwapParamsTokenOut$inboundSchema;
+  /** @deprecated use `OdosSwapParamsTokenOut$outboundSchema` instead. */
+  export const outboundSchema = OdosSwapParamsTokenOut$outboundSchema;
+  /** @deprecated use `OdosSwapParamsTokenOut$Outbound` instead. */
+  export type Outbound = OdosSwapParamsTokenOut$Outbound;
+}
+
+export function odosSwapParamsTokenOutToJSON(
+  odosSwapParamsTokenOut: OdosSwapParamsTokenOut,
+): string {
+  return JSON.stringify(
+    OdosSwapParamsTokenOut$outboundSchema.parse(odosSwapParamsTokenOut),
+  );
+}
+
+export function odosSwapParamsTokenOutFromJSON(
+  jsonString: string,
+): SafeParseResult<OdosSwapParamsTokenOut, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OdosSwapParamsTokenOut$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OdosSwapParamsTokenOut' from JSON`,
+  );
+}
+
+/** @internal */
+export const OdosSwapParamsAmount$inboundSchema: z.ZodType<
+  OdosSwapParamsAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type OdosSwapParamsAmount$Outbound = number | string;
+
+/** @internal */
+export const OdosSwapParamsAmount$outboundSchema: z.ZodType<
+  OdosSwapParamsAmount$Outbound,
+  z.ZodTypeDef,
+  OdosSwapParamsAmount
+> = z.union([z.number(), z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OdosSwapParamsAmount$ {
+  /** @deprecated use `OdosSwapParamsAmount$inboundSchema` instead. */
+  export const inboundSchema = OdosSwapParamsAmount$inboundSchema;
+  /** @deprecated use `OdosSwapParamsAmount$outboundSchema` instead. */
+  export const outboundSchema = OdosSwapParamsAmount$outboundSchema;
+  /** @deprecated use `OdosSwapParamsAmount$Outbound` instead. */
+  export type Outbound = OdosSwapParamsAmount$Outbound;
+}
+
+export function odosSwapParamsAmountToJSON(
+  odosSwapParamsAmount: OdosSwapParamsAmount,
+): string {
+  return JSON.stringify(
+    OdosSwapParamsAmount$outboundSchema.parse(odosSwapParamsAmount),
+  );
+}
+
+export function odosSwapParamsAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<OdosSwapParamsAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OdosSwapParamsAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OdosSwapParamsAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const OdosSwapParams$inboundSchema: z.ZodType<
+  OdosSwapParams,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  action_type: z.literal("ODOS_SWAP").default("ODOS_SWAP"),
+  token_in: z.union([TokenEnum$inboundSchema, z.string()]),
+  token_out: z.union([TokenEnum$inboundSchema, z.string()]),
+  amount: z.union([z.number(), z.string()]),
+  max_slippage_percent: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "action_type": "actionType",
+    "token_in": "tokenIn",
+    "token_out": "tokenOut",
+    "max_slippage_percent": "maxSlippagePercent",
+  });
+});
+
+/** @internal */
+export type OdosSwapParams$Outbound = {
+  action_type: "ODOS_SWAP";
+  token_in: string | string;
+  token_out: string | string;
+  amount: number | string;
+  max_slippage_percent: number;
+};
+
+/** @internal */
+export const OdosSwapParams$outboundSchema: z.ZodType<
+  OdosSwapParams$Outbound,
+  z.ZodTypeDef,
+  OdosSwapParams
+> = z.object({
+  actionType: z.literal("ODOS_SWAP").default("ODOS_SWAP" as const),
+  tokenIn: z.union([TokenEnum$outboundSchema, z.string()]),
+  tokenOut: z.union([TokenEnum$outboundSchema, z.string()]),
+  amount: z.union([z.number(), z.string()]),
+  maxSlippagePercent: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    actionType: "action_type",
+    tokenIn: "token_in",
+    tokenOut: "token_out",
+    maxSlippagePercent: "max_slippage_percent",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OdosSwapParams$ {
+  /** @deprecated use `OdosSwapParams$inboundSchema` instead. */
+  export const inboundSchema = OdosSwapParams$inboundSchema;
+  /** @deprecated use `OdosSwapParams$outboundSchema` instead. */
+  export const outboundSchema = OdosSwapParams$outboundSchema;
+  /** @deprecated use `OdosSwapParams$Outbound` instead. */
+  export type Outbound = OdosSwapParams$Outbound;
+}
+
+export function odosSwapParamsToJSON(odosSwapParams: OdosSwapParams): string {
+  return JSON.stringify(OdosSwapParams$outboundSchema.parse(odosSwapParams));
+}
+
+export function odosSwapParamsFromJSON(
+  jsonString: string,
+): SafeParseResult<OdosSwapParams, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OdosSwapParams$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OdosSwapParams' from JSON`,
+  );
+}