@compass-labs/api-sdk 1.0.4 → 1.0.6

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

package/src/models/components/ethenadepositparams.ts

@@ -0,0 +1,142 @@
+/*
+ * 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";
+
+/**
+ * The amount of USDe to deposit into Ethena's vault.
+ */
+export type EthenaDepositParamsAmount = number | string;
+
+export type EthenaDepositParams = {
+  actionType?: "ETHENA_DEPOSIT" | undefined;
+  /**
+   * The amount of USDe to deposit into Ethena's vault.
+   */
+  amount: number | string;
+  /**
+   * The address which will receive the shares (sUSDe) from Ethena's vault representing their proportional ownership of the vault's assets. Defaults to the sender.
+   */
+  receiver?: string | null | undefined;
+};
+
+/** @internal */
+export const EthenaDepositParamsAmount$inboundSchema: z.ZodType<
+  EthenaDepositParamsAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type EthenaDepositParamsAmount$Outbound = number | string;
+
+/** @internal */
+export const EthenaDepositParamsAmount$outboundSchema: z.ZodType<
+  EthenaDepositParamsAmount$Outbound,
+  z.ZodTypeDef,
+  EthenaDepositParamsAmount
+> = 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 EthenaDepositParamsAmount$ {
+  /** @deprecated use `EthenaDepositParamsAmount$inboundSchema` instead. */
+  export const inboundSchema = EthenaDepositParamsAmount$inboundSchema;
+  /** @deprecated use `EthenaDepositParamsAmount$outboundSchema` instead. */
+  export const outboundSchema = EthenaDepositParamsAmount$outboundSchema;
+  /** @deprecated use `EthenaDepositParamsAmount$Outbound` instead. */
+  export type Outbound = EthenaDepositParamsAmount$Outbound;
+}
+
+export function ethenaDepositParamsAmountToJSON(
+  ethenaDepositParamsAmount: EthenaDepositParamsAmount,
+): string {
+  return JSON.stringify(
+    EthenaDepositParamsAmount$outboundSchema.parse(ethenaDepositParamsAmount),
+  );
+}
+
+export function ethenaDepositParamsAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<EthenaDepositParamsAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EthenaDepositParamsAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EthenaDepositParamsAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const EthenaDepositParams$inboundSchema: z.ZodType<
+  EthenaDepositParams,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  action_type: z.literal("ETHENA_DEPOSIT").default("ETHENA_DEPOSIT"),
+  amount: z.union([z.number(), z.string()]),
+  receiver: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "action_type": "actionType",
+  });
+});
+
+/** @internal */
+export type EthenaDepositParams$Outbound = {
+  action_type: "ETHENA_DEPOSIT";
+  amount: number | string;
+  receiver?: string | null | undefined;
+};
+
+/** @internal */
+export const EthenaDepositParams$outboundSchema: z.ZodType<
+  EthenaDepositParams$Outbound,
+  z.ZodTypeDef,
+  EthenaDepositParams
+> = z.object({
+  actionType: z.literal("ETHENA_DEPOSIT").default("ETHENA_DEPOSIT" as const),
+  amount: z.union([z.number(), z.string()]),
+  receiver: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    actionType: "action_type",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EthenaDepositParams$ {
+  /** @deprecated use `EthenaDepositParams$inboundSchema` instead. */
+  export const inboundSchema = EthenaDepositParams$inboundSchema;
+  /** @deprecated use `EthenaDepositParams$outboundSchema` instead. */
+  export const outboundSchema = EthenaDepositParams$outboundSchema;
+  /** @deprecated use `EthenaDepositParams$Outbound` instead. */
+  export type Outbound = EthenaDepositParams$Outbound;
+}
+
+export function ethenaDepositParamsToJSON(
+  ethenaDepositParams: EthenaDepositParams,
+): string {
+  return JSON.stringify(
+    EthenaDepositParams$outboundSchema.parse(ethenaDepositParams),
+  );
+}
+
+export function ethenaDepositParamsFromJSON(
+  jsonString: string,
+): SafeParseResult<EthenaDepositParams, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EthenaDepositParams$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EthenaDepositParams' from JSON`,
+  );
+}

package/src/models/components/ethenadepositrequest.ts

@@ -0,0 +1,182 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The amount of USDe to deposit into Ethena's vault.
+ */
+export type EthenaDepositRequestAmount = number | string;
+
+export const EthenaDepositRequestChain = {
+  Ethereum: "ethereum",
+} as const;
+export type EthenaDepositRequestChain = ClosedEnum<
+  typeof EthenaDepositRequestChain
+>;
+
+export type EthenaDepositRequest = {
+  actionType?: "ETHENA_DEPOSIT" | undefined;
+  /**
+   * The amount of USDe to deposit into Ethena's vault.
+   */
+  amount: number | string;
+  /**
+   * The address which will receive the shares (sUSDe) from Ethena's vault representing their proportional ownership of the vault's assets. Defaults to the sender.
+   */
+  receiver?: string | null | undefined;
+  chain: EthenaDepositRequestChain;
+  /**
+   * The address of the transaction sender.
+   */
+  sender: string;
+};
+
+/** @internal */
+export const EthenaDepositRequestAmount$inboundSchema: z.ZodType<
+  EthenaDepositRequestAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type EthenaDepositRequestAmount$Outbound = number | string;
+
+/** @internal */
+export const EthenaDepositRequestAmount$outboundSchema: z.ZodType<
+  EthenaDepositRequestAmount$Outbound,
+  z.ZodTypeDef,
+  EthenaDepositRequestAmount
+> = 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 EthenaDepositRequestAmount$ {
+  /** @deprecated use `EthenaDepositRequestAmount$inboundSchema` instead. */
+  export const inboundSchema = EthenaDepositRequestAmount$inboundSchema;
+  /** @deprecated use `EthenaDepositRequestAmount$outboundSchema` instead. */
+  export const outboundSchema = EthenaDepositRequestAmount$outboundSchema;
+  /** @deprecated use `EthenaDepositRequestAmount$Outbound` instead. */
+  export type Outbound = EthenaDepositRequestAmount$Outbound;
+}
+
+export function ethenaDepositRequestAmountToJSON(
+  ethenaDepositRequestAmount: EthenaDepositRequestAmount,
+): string {
+  return JSON.stringify(
+    EthenaDepositRequestAmount$outboundSchema.parse(ethenaDepositRequestAmount),
+  );
+}
+
+export function ethenaDepositRequestAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<EthenaDepositRequestAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EthenaDepositRequestAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EthenaDepositRequestAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const EthenaDepositRequestChain$inboundSchema: z.ZodNativeEnum<
+  typeof EthenaDepositRequestChain
+> = z.nativeEnum(EthenaDepositRequestChain);
+
+/** @internal */
+export const EthenaDepositRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof EthenaDepositRequestChain
+> = EthenaDepositRequestChain$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EthenaDepositRequestChain$ {
+  /** @deprecated use `EthenaDepositRequestChain$inboundSchema` instead. */
+  export const inboundSchema = EthenaDepositRequestChain$inboundSchema;
+  /** @deprecated use `EthenaDepositRequestChain$outboundSchema` instead. */
+  export const outboundSchema = EthenaDepositRequestChain$outboundSchema;
+}
+
+/** @internal */
+export const EthenaDepositRequest$inboundSchema: z.ZodType<
+  EthenaDepositRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  action_type: z.literal("ETHENA_DEPOSIT").default("ETHENA_DEPOSIT"),
+  amount: z.union([z.number(), z.string()]),
+  receiver: z.nullable(z.string()).optional(),
+  chain: EthenaDepositRequestChain$inboundSchema,
+  sender: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "action_type": "actionType",
+  });
+});
+
+/** @internal */
+export type EthenaDepositRequest$Outbound = {
+  action_type: "ETHENA_DEPOSIT";
+  amount: number | string;
+  receiver?: string | null | undefined;
+  chain: string;
+  sender: string;
+};
+
+/** @internal */
+export const EthenaDepositRequest$outboundSchema: z.ZodType<
+  EthenaDepositRequest$Outbound,
+  z.ZodTypeDef,
+  EthenaDepositRequest
+> = z.object({
+  actionType: z.literal("ETHENA_DEPOSIT").default("ETHENA_DEPOSIT" as const),
+  amount: z.union([z.number(), z.string()]),
+  receiver: z.nullable(z.string()).optional(),
+  chain: EthenaDepositRequestChain$outboundSchema,
+  sender: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    actionType: "action_type",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EthenaDepositRequest$ {
+  /** @deprecated use `EthenaDepositRequest$inboundSchema` instead. */
+  export const inboundSchema = EthenaDepositRequest$inboundSchema;
+  /** @deprecated use `EthenaDepositRequest$outboundSchema` instead. */
+  export const outboundSchema = EthenaDepositRequest$outboundSchema;
+  /** @deprecated use `EthenaDepositRequest$Outbound` instead. */
+  export type Outbound = EthenaDepositRequest$Outbound;
+}
+
+export function ethenaDepositRequestToJSON(
+  ethenaDepositRequest: EthenaDepositRequest,
+): string {
+  return JSON.stringify(
+    EthenaDepositRequest$outboundSchema.parse(ethenaDepositRequest),
+  );
+}
+
+export function ethenaDepositRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<EthenaDepositRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EthenaDepositRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EthenaDepositRequest' from JSON`,
+  );
+}