@compass-labs/api-sdk 1.0.4 → 1.0.6

package/src/funcs/ethenaEthenaRequest.ts

@@ -0,0 +1,189 @@
+/*
+ * 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";
+
+/**
+ * Request to Withdraw USDe
+ *
+ * @remarks
+ * 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>
+ */
+export function ethenaEthenaRequest(
+  client: CompassApiSDKCore,
+  request: components.EthenaRequestToWithdrawRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.EthenaRequestToWithdrawTransactionResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.EthenaRequestToWithdrawRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.EthenaRequestToWithdrawTransactionResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.EthenaRequestToWithdrawRequest$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/request")();
+
+  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_request",
+    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.EthenaRequestToWithdrawTransactionResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      components.EthenaRequestToWithdrawTransactionResponse$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/ethenaEthenaVault.ts

@@ -0,0 +1,173 @@
+/*
+ * 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";
+
+/**
+ * Get Vault & User Position
+ */
+export function ethenaEthenaVault(
+  client: CompassApiSDKCore,
+  request: operations.V1EthenaVaultRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.EthenaGetVaultResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: operations.V1EthenaVaultRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.EthenaGetVaultResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.V1EthenaVaultRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v1/ethena/vault")();
+
+  const query = encodeFormQuery({
+    "block": payload.block,
+    "chain": payload.chain,
+    "user_address": payload.user_address,
+  });
+
+  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: "v1_ethena_vault",
+    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.EthenaGetVaultResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.EthenaGetVaultResponse$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/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.4",
+  sdkVersion: "1.0.6",
   genVersion: "2.675.0",
   userAgent:
-    "speakeasy-sdk/typescript 1.0.4 2.675.0 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 1.0.6 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.4",
+    currentVersion: "1.0.6",
   },
 });
 

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.4",
+    version: "1.0.6",
   });
 
   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/aaveV3AaveHistoricalTransactions.ts

@@ -21,7 +21,11 @@ This endpoint retrieves historical transactions for a user on the AAVE platform.
 It returns a list of transactions including deposits, withdrawals, borrows, and
 repayments. Each transaction includes details such as the token, amount, timestamp,
 and transaction type. This provides a comprehensive view of the user's historical
-activity within the AAVE protocol.`,
+activity within the AAVE protocol.
+
+⚠️ Data comes from the official Aave subgraph (
+https://github.com/aave/protocol-subgraphs)
+and thus this particular endpoint may be less reliable than our other endpoints. ⚠️`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await aaveV3AaveHistoricalTransactions(

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);
+  },
+};