@compass-labs/api-sdk 1.0.3 → 1.0.5

package/src/funcs/ethenaEthenaWithdraw.ts

@@ -0,0 +1,180 @@
+/*
+ * 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";
+
+/**
+ * Withdraw USDe
+ *
+ * @remarks
+ * Withdraw deposited USDe from Ethena's vault and cease earning passive yield.
+ *
+ * The passive yield earned on USDe deposits is represented by the increased value of
+ * the shares received (sUSDe) upon depositing USDe. Trade in these shares in exchange
+ * for the intial USDe deposited and any accrued yield since depositing.
+ *                     <Info>
+ *                     **Required Allowances**
+ *
+ *                         In order to make this transaction, token allowances need to be set for the following contracts.
+ *
+ *                      - `EthenaVault`
+ *                     </Info>
+ */
+export function ethenaEthenaWithdraw(
+  client: CompassApiSDKCore,
+  request: components.EthenaWithdrawRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.TransactionResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.EthenaWithdrawRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.TransactionResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.EthenaWithdrawRequest$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("/v1/ethena/withdraw")();
+
+  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: "v1_ethena_withdraw",
+    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.TransactionResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.TransactionResponse$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: "1.0.3",
-  genVersion: "2.674.3",
+  sdkVersion: "1.0.5",
+  genVersion: "2.675.0",
   userAgent:
-    "speakeasy-sdk/typescript 1.0.3 2.674.3 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 1.0.5 2.675.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: "1.0.3",
+    currentVersion: "1.0.5",
   },
 });
 

package/src/mcp-server/server.ts

@@ -37,6 +37,10 @@ import { tool$aerodromeSlipstreamAerodromeSlipstreamSwapSellExactly } from "./to
 import { tool$erc4626VaultsVaultsDeposit } from "./tools/erc4626VaultsVaultsDeposit.js";
 import { tool$erc4626VaultsVaultsVault } from "./tools/erc4626VaultsVaultsVault.js";
 import { tool$erc4626VaultsVaultsWithdraw } from "./tools/erc4626VaultsVaultsWithdraw.js";
+import { tool$ethenaEthenaDeposit } from "./tools/ethenaEthenaDeposit.js";
+import { tool$ethenaEthenaRequest } from "./tools/ethenaEthenaRequest.js";
+import { tool$ethenaEthenaVault } from "./tools/ethenaEthenaVault.js";
+import { tool$ethenaEthenaWithdraw } from "./tools/ethenaEthenaWithdraw.js";
 import { tool$morphoMorphoBorrow } from "./tools/morphoMorphoBorrow.js";
 import { tool$morphoMorphoDeposit } from "./tools/morphoMorphoDeposit.js";
 import { tool$morphoMorphoMarket } from "./tools/morphoMorphoMarket.js";
@@ -99,7 +103,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "CompassApiSDK",
-    version: "1.0.3",
+    version: "1.0.5",
   });
 
   const client = new CompassApiSDKCore({
@@ -204,6 +208,10 @@ export function createMCPServer(deps: {
   tool(tool$erc4626VaultsVaultsVault);
   tool(tool$erc4626VaultsVaultsDeposit);
   tool(tool$erc4626VaultsVaultsWithdraw);
+  tool(tool$ethenaEthenaVault);
+  tool(tool$ethenaEthenaDeposit);
+  tool(tool$ethenaEthenaWithdraw);
+  tool(tool$ethenaEthenaRequest);
 
   return server;
 }

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

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ethenaEthenaDeposit } from "../../funcs/ethenaEthenaDeposit.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: components.EthenaDepositRequest$inboundSchema,
+};
+
+export const tool$ethenaEthenaDeposit: ToolDefinition<typeof args> = {
+  name: "ethena-ethena-deposit",
+  description: `Deposit USDe
+
+Deposit USDe into a Ethena's Vault to earn passive yield.
+
+The shares of a deposit are respresented as sUSDe.
+                    <Info>
+                    **Required Allowances**
+
+                        In order to make this transaction, token allowances need to be set for the following contracts.
+
+                     - \`EthenaVault\`
+                    </Info>
+                `,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await ethenaEthenaDeposit(
+      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/ethenaEthenaRequest.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ethenaEthenaRequest } from "../../funcs/ethenaEthenaRequest.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: components.EthenaRequestToWithdrawRequest$inboundSchema,
+};
+
+export const tool$ethenaEthenaRequest: ToolDefinition<typeof args> = {
+  name: "ethena-ethena-request",
+  description: `Request to Withdraw USDe
+
+Request to withdraw deposited USDe from Ethena's vault.
+
+The Ethena vault requires a cooldown period. Once a request to withdraw a specified
+amount of USDe has been submitted, the alloted cooldown period must pass before the
+withdraw USDe transaction can be submitted.
+
+If an additional amount of USDe is requested to be withdrawn anytime before
+withdrawing the originally requested amount, the cooldown period restarts.
+
+Yield is not earned on USDe while in its cooldown period.
+                    <Info>
+                    **Required Allowances**
+
+                        In order to make this transaction, token allowances need to be set for the following contracts.
+
+                     - \`EthenaVault\`
+                    </Info>
+                `,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await ethenaEthenaRequest(
+      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/ethenaEthenaVault.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ethenaEthenaVault } from "../../funcs/ethenaEthenaVault.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.V1EthenaVaultRequest$inboundSchema,
+};
+
+export const tool$ethenaEthenaVault: ToolDefinition<typeof args> = {
+  name: "ethena-ethena-vault",
+  description: `Get Vault & User Position`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await ethenaEthenaVault(
+      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/ethenaEthenaWithdraw.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ethenaEthenaWithdraw } from "../../funcs/ethenaEthenaWithdraw.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: components.EthenaWithdrawRequest$inboundSchema,
+};
+
+export const tool$ethenaEthenaWithdraw: ToolDefinition<typeof args> = {
+  name: "ethena-ethena-withdraw",
+  description: `Withdraw USDe
+
+Withdraw deposited USDe from Ethena's vault and cease earning passive yield.
+
+The passive yield earned on USDe deposits is represented by the increased value of
+the shares received (sUSDe) upon depositing USDe. Trade in these shares in exchange
+for the intial USDe deposited and any accrued yield since depositing.
+                    <Info>
+                    **Required Allowances**
+
+                        In order to make this transaction, token allowances need to be set for the following contracts.
+
+                     - \`EthenaVault\`
+                    </Info>
+                `,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await ethenaEthenaWithdraw(
+      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/compassapibackendmodelsvaultsreadresponsevaultuserposition.ts

@@ -9,8 +9,14 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type CompassApiBackendModelsVaultsReadResponseVaultUserPosition = {
-  shares: number;
-  tokenAmount: string;
+  /**
+   * The number of vault share tokens representing the user’s proportional ownership of the assets in the vault.
+   */
+  amountOfShares: string;
+  /**
+   * The equivalent value of the user’s vault shares, denominated in the vault’s underlying asset (deposit token).
+   */
+  amountInUnderlyingToken: string;
 };
 
 /** @internal */
@@ -20,19 +26,20 @@ export const CompassApiBackendModelsVaultsReadResponseVaultUserPosition$inboundS
     z.ZodTypeDef,
     unknown
   > = z.object({
-    shares: z.number().int(),
-    token_amount: z.string(),
+    amount_of_shares: z.string(),
+    amount_in_underlying_token: z.string(),
   }).transform((v) => {
     return remap$(v, {
-      "token_amount": "tokenAmount",
+      "amount_of_shares": "amountOfShares",
+      "amount_in_underlying_token": "amountInUnderlyingToken",
     });
   });
 
 /** @internal */
 export type CompassApiBackendModelsVaultsReadResponseVaultUserPosition$Outbound =
   {
-    shares: number;
-    token_amount: string;
+    amount_of_shares: string;
+    amount_in_underlying_token: string;
   };
 
 /** @internal */
@@ -42,11 +49,12 @@ export const CompassApiBackendModelsVaultsReadResponseVaultUserPosition$outbound
     z.ZodTypeDef,
     CompassApiBackendModelsVaultsReadResponseVaultUserPosition
   > = z.object({
-    shares: z.number().int(),
-    tokenAmount: z.string(),
+    amountOfShares: z.string(),
+    amountInUnderlyingToken: z.string(),
   }).transform((v) => {
     return remap$(v, {
-      tokenAmount: "token_amount",
+      amountOfShares: "amount_of_shares",
+      amountInUnderlyingToken: "amount_in_underlying_token",
     });
   });
 

package/src/models/components/cooldownposition.ts

@@ -0,0 +1,151 @@
+/*
+ * 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";
+
+/**
+ * When the cooldown period ends. ISO 8601 format. UTC timezone.
+ */
+export type CooldownEnd = Date | boolean;
+
+export type CooldownPosition = {
+  /**
+   * The amount of USDe currently in a cooldown period.
+   */
+  amountInUnderlyingAsset: string;
+  /**
+   * When the cooldown period ends. ISO 8601 format. UTC timezone.
+   */
+  cooldownEnd: Date | boolean;
+  /**
+   * Whether the USDe in cooldown can be withdrawn at this moment.
+   */
+  canBeWithdrawn: boolean;
+};
+
+/** @internal */
+export const CooldownEnd$inboundSchema: z.ZodType<
+  CooldownEnd,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  z.boolean(),
+]);
+
+/** @internal */
+export type CooldownEnd$Outbound = string | boolean;
+
+/** @internal */
+export const CooldownEnd$outboundSchema: z.ZodType<
+  CooldownEnd$Outbound,
+  z.ZodTypeDef,
+  CooldownEnd
+> = z.union([z.date().transform(v => v.toISOString()), z.boolean()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CooldownEnd$ {
+  /** @deprecated use `CooldownEnd$inboundSchema` instead. */
+  export const inboundSchema = CooldownEnd$inboundSchema;
+  /** @deprecated use `CooldownEnd$outboundSchema` instead. */
+  export const outboundSchema = CooldownEnd$outboundSchema;
+  /** @deprecated use `CooldownEnd$Outbound` instead. */
+  export type Outbound = CooldownEnd$Outbound;
+}
+
+export function cooldownEndToJSON(cooldownEnd: CooldownEnd): string {
+  return JSON.stringify(CooldownEnd$outboundSchema.parse(cooldownEnd));
+}
+
+export function cooldownEndFromJSON(
+  jsonString: string,
+): SafeParseResult<CooldownEnd, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CooldownEnd$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CooldownEnd' from JSON`,
+  );
+}
+
+/** @internal */
+export const CooldownPosition$inboundSchema: z.ZodType<
+  CooldownPosition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amount_in_underlying_asset: z.string(),
+  cooldown_end: z.union([
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    z.boolean(),
+  ]),
+  can_be_withdrawn: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "amount_in_underlying_asset": "amountInUnderlyingAsset",
+    "cooldown_end": "cooldownEnd",
+    "can_be_withdrawn": "canBeWithdrawn",
+  });
+});
+
+/** @internal */
+export type CooldownPosition$Outbound = {
+  amount_in_underlying_asset: string;
+  cooldown_end: string | boolean;
+  can_be_withdrawn: boolean;
+};
+
+/** @internal */
+export const CooldownPosition$outboundSchema: z.ZodType<
+  CooldownPosition$Outbound,
+  z.ZodTypeDef,
+  CooldownPosition
+> = z.object({
+  amountInUnderlyingAsset: z.string(),
+  cooldownEnd: z.union([z.date().transform(v => v.toISOString()), z.boolean()]),
+  canBeWithdrawn: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    amountInUnderlyingAsset: "amount_in_underlying_asset",
+    cooldownEnd: "cooldown_end",
+    canBeWithdrawn: "can_be_withdrawn",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CooldownPosition$ {
+  /** @deprecated use `CooldownPosition$inboundSchema` instead. */
+  export const inboundSchema = CooldownPosition$inboundSchema;
+  /** @deprecated use `CooldownPosition$outboundSchema` instead. */
+  export const outboundSchema = CooldownPosition$outboundSchema;
+  /** @deprecated use `CooldownPosition$Outbound` instead. */
+  export type Outbound = CooldownPosition$Outbound;
+}
+
+export function cooldownPositionToJSON(
+  cooldownPosition: CooldownPosition,
+): string {
+  return JSON.stringify(
+    CooldownPosition$outboundSchema.parse(cooldownPosition),
+  );
+}
+
+export function cooldownPositionFromJSON(
+  jsonString: string,
+): SafeParseResult<CooldownPosition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CooldownPosition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CooldownPosition' from JSON`,
+  );
+}