@compass-labs/api-sdk 2.2.34-rc.3 → 2.2.34-rc.4

package/src/models/components/traditionalinvestingexecuterequest.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+/**
+ * Submit a signed Hyperliquid action for execution.
+ */
+export type TraditionalInvestingExecuteRequest = {
+  /**
+   * Raw Hyperliquid action from the prepare step
+   */
+  action: { [k: string]: any };
+  /**
+   * Nonce from the prepare step
+   */
+  nonce: number;
+  /**
+   * User's EIP-712 signature (hex, 65 bytes)
+   */
+  signature: string;
+  /**
+   * Optional vault address
+   */
+  vaultAddress?: string | null | undefined;
+};
+
+/** @internal */
+export type TraditionalInvestingExecuteRequest$Outbound = {
+  action: { [k: string]: any };
+  nonce: number;
+  signature: string;
+  vault_address?: string | null | undefined;
+};
+
+/** @internal */
+export const TraditionalInvestingExecuteRequest$outboundSchema: z.ZodType<
+  TraditionalInvestingExecuteRequest$Outbound,
+  z.ZodTypeDef,
+  TraditionalInvestingExecuteRequest
+> = z.object({
+  action: z.record(z.any()),
+  nonce: z.number().int(),
+  signature: z.string(),
+  vaultAddress: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    vaultAddress: "vault_address",
+  });
+});
+
+export function traditionalInvestingExecuteRequestToJSON(
+  traditionalInvestingExecuteRequest: TraditionalInvestingExecuteRequest,
+): string {
+  return JSON.stringify(
+    TraditionalInvestingExecuteRequest$outboundSchema.parse(
+      traditionalInvestingExecuteRequest,
+    ),
+  );
+}

package/src/models/components/traditionalinvestingexecuteresponse.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Returned after submitting a signed action to the Hyperliquid exchange.
+ */
+export type TraditionalInvestingExecuteResponse = {
+  /**
+   * 'ok' or 'error'
+   */
+  status: string;
+  /**
+   * Hyperliquid response data (order statuses, etc.)
+   */
+  response?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const TraditionalInvestingExecuteResponse$inboundSchema: z.ZodType<
+  TraditionalInvestingExecuteResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: z.string(),
+  response: z.record(z.any()).optional(),
+});
+
+export function traditionalInvestingExecuteResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TraditionalInvestingExecuteResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TraditionalInvestingExecuteResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TraditionalInvestingExecuteResponse' from JSON`,
+  );
+}

package/src/models/components/{tradfilimitorderrequest.ts → traditionalinvestinglimitorderrequest.ts}

@@ -6,11 +6,11 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 /**
- * Request to place a limit order on a TradFi perp market.
+ * Request to place a limit order on a traditional investing perp market.
  */
-export type TradFiLimitOrderRequest = {
+export type TraditionalInvestingLimitOrderRequest = {
   /**
-   * Owner of the TradFi product account
+   * Owner of the traditional investing product account
    */
   owner: string;
   /**
@@ -44,7 +44,7 @@ export type TradFiLimitOrderRequest = {
 };
 
 /** @internal */
-export type TradFiLimitOrderRequest$Outbound = {
+export type TraditionalInvestingLimitOrderRequest$Outbound = {
   owner: string;
   asset: string;
   side: string;
@@ -56,10 +56,10 @@ export type TradFiLimitOrderRequest$Outbound = {
 };
 
 /** @internal */
-export const TradFiLimitOrderRequest$outboundSchema: z.ZodType<
-  TradFiLimitOrderRequest$Outbound,
+export const TraditionalInvestingLimitOrderRequest$outboundSchema: z.ZodType<
+  TraditionalInvestingLimitOrderRequest$Outbound,
   z.ZodTypeDef,
-  TradFiLimitOrderRequest
+  TraditionalInvestingLimitOrderRequest
 > = z.object({
   owner: z.string(),
   asset: z.string(),
@@ -77,10 +77,12 @@ export const TradFiLimitOrderRequest$outboundSchema: z.ZodType<
   });
 });
 
-export function tradFiLimitOrderRequestToJSON(
-  tradFiLimitOrderRequest: TradFiLimitOrderRequest,
+export function traditionalInvestingLimitOrderRequestToJSON(
+  traditionalInvestingLimitOrderRequest: TraditionalInvestingLimitOrderRequest,
 ): string {
   return JSON.stringify(
-    TradFiLimitOrderRequest$outboundSchema.parse(tradFiLimitOrderRequest),
+    TraditionalInvestingLimitOrderRequest$outboundSchema.parse(
+      traditionalInvestingLimitOrderRequest,
+    ),
   );
 }

package/src/models/components/{tradfimarketorderrequest.ts → traditionalinvestingmarketorderrequest.ts}

@@ -6,11 +6,11 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 /**
- * Request to place a market order on a TradFi perp market.
+ * Request to place a market order on a traditional investing perp market.
  */
-export type TradFiMarketOrderRequest = {
+export type TraditionalInvestingMarketOrderRequest = {
   /**
-   * Owner of the TradFi product account
+   * Owner of the traditional investing product account
    */
   owner: string;
   /**
@@ -36,7 +36,7 @@ export type TradFiMarketOrderRequest = {
 };
 
 /** @internal */
-export type TradFiMarketOrderRequest$Outbound = {
+export type TraditionalInvestingMarketOrderRequest$Outbound = {
   owner: string;
   asset: string;
   side: string;
@@ -46,10 +46,10 @@ export type TradFiMarketOrderRequest$Outbound = {
 };
 
 /** @internal */
-export const TradFiMarketOrderRequest$outboundSchema: z.ZodType<
-  TradFiMarketOrderRequest$Outbound,
+export const TraditionalInvestingMarketOrderRequest$outboundSchema: z.ZodType<
+  TraditionalInvestingMarketOrderRequest$Outbound,
   z.ZodTypeDef,
-  TradFiMarketOrderRequest
+  TraditionalInvestingMarketOrderRequest
 > = z.object({
   owner: z.string(),
   asset: z.string(),
@@ -64,10 +64,13 @@ export const TradFiMarketOrderRequest$outboundSchema: z.ZodType<
   });
 });
 
-export function tradFiMarketOrderRequestToJSON(
-  tradFiMarketOrderRequest: TradFiMarketOrderRequest,
+export function traditionalInvestingMarketOrderRequestToJSON(
+  traditionalInvestingMarketOrderRequest:
+    TraditionalInvestingMarketOrderRequest,
 ): string {
   return JSON.stringify(
-    TradFiMarketOrderRequest$outboundSchema.parse(tradFiMarketOrderRequest),
+    TraditionalInvestingMarketOrderRequest$outboundSchema.parse(
+      traditionalInvestingMarketOrderRequest,
+    ),
   );
 }

package/src/models/components/traditionalinvestingopportunitiesresponse.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  TraditionalInvestingOpportunity,
+  TraditionalInvestingOpportunity$inboundSchema,
+} from "./traditionalinvestingopportunity.js";
+
+/**
+ * List of available traditional investing perpetual futures markets.
+ */
+export type TraditionalInvestingOpportunitiesResponse = {
+  /**
+   * Available traditional investing perp markets
+   */
+  opportunities: Array<TraditionalInvestingOpportunity>;
+};
+
+/** @internal */
+export const TraditionalInvestingOpportunitiesResponse$inboundSchema: z.ZodType<
+  TraditionalInvestingOpportunitiesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  opportunities: z.array(TraditionalInvestingOpportunity$inboundSchema),
+});
+
+export function traditionalInvestingOpportunitiesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  TraditionalInvestingOpportunitiesResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TraditionalInvestingOpportunitiesResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'TraditionalInvestingOpportunitiesResponse' from JSON`,
+  );
+}

package/src/models/components/{tradfiopportunity.ts → traditionalinvestingopportunity.ts}

@@ -9,9 +9,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * A single TradFi perpetual futures market.
+ * A single traditional investing perpetual futures market.
  */
-export type TradFiOpportunity = {
+export type TraditionalInvestingOpportunity = {
   /**
    * Asset ticker symbol (e.g. AAPL, GOLD, EUR)
    */
@@ -55,8 +55,8 @@ export type TradFiOpportunity = {
 };
 
 /** @internal */
-export const TradFiOpportunity$inboundSchema: z.ZodType<
-  TradFiOpportunity,
+export const TraditionalInvestingOpportunity$inboundSchema: z.ZodType<
+  TraditionalInvestingOpportunity,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -83,12 +83,12 @@ export const TradFiOpportunity$inboundSchema: z.ZodType<
   });
 });
 
-export function tradFiOpportunityFromJSON(
+export function traditionalInvestingOpportunityFromJSON(
   jsonString: string,
-): SafeParseResult<TradFiOpportunity, SDKValidationError> {
+): SafeParseResult<TraditionalInvestingOpportunity, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => TradFiOpportunity$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'TradFiOpportunity' from JSON`,
+    (x) => TraditionalInvestingOpportunity$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TraditionalInvestingOpportunity' from JSON`,
   );
 }

package/src/models/components/{tradfiposition.ts → traditionalinvestingposition.ts}

@@ -24,7 +24,7 @@ export type Side = ClosedEnum<typeof Side>;
 /**
  * A single open perpetual futures position.
  */
-export type TradFiPosition = {
+export type TraditionalInvestingPosition = {
   /**
    * Asset ticker symbol
    */
@@ -77,8 +77,8 @@ export const Side$inboundSchema: z.ZodNativeEnum<typeof Side> = z.nativeEnum(
 );
 
 /** @internal */
-export const TradFiPosition$inboundSchema: z.ZodType<
-  TradFiPosition,
+export const TraditionalInvestingPosition$inboundSchema: z.ZodType<
+  TraditionalInvestingPosition,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -105,12 +105,12 @@ export const TradFiPosition$inboundSchema: z.ZodType<
   });
 });
 
-export function tradFiPositionFromJSON(
+export function traditionalInvestingPositionFromJSON(
   jsonString: string,
-): SafeParseResult<TradFiPosition, SDKValidationError> {
+): SafeParseResult<TraditionalInvestingPosition, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => TradFiPosition$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'TradFiPosition' from JSON`,
+    (x) => TraditionalInvestingPosition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TraditionalInvestingPosition' from JSON`,
   );
 }

package/src/models/components/traditionalinvestingpositionsresponse.ts

@@ -0,0 +1,57 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  TraditionalInvestingPosition,
+  TraditionalInvestingPosition$inboundSchema,
+} from "./traditionalinvestingposition.js";
+
+/**
+ * List of open traditional investing perp positions with account balance.
+ */
+export type TraditionalInvestingPositionsResponse = {
+  /**
+   * Open perpetual futures positions
+   */
+  positions: Array<TraditionalInvestingPosition>;
+  /**
+   * Total account value in USD (margin + unrealized PnL)
+   */
+  accountValue?: string | undefined;
+  /**
+   * Available USDC balance (withdrawable margin)
+   */
+  withdrawable?: string | undefined;
+};
+
+/** @internal */
+export const TraditionalInvestingPositionsResponse$inboundSchema: z.ZodType<
+  TraditionalInvestingPositionsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  positions: z.array(TraditionalInvestingPosition$inboundSchema),
+  account_value: z.string().optional(),
+  withdrawable: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "account_value": "accountValue",
+  });
+});
+
+export function traditionalInvestingPositionsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TraditionalInvestingPositionsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TraditionalInvestingPositionsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TraditionalInvestingPositionsResponse' from JSON`,
+  );
+}

package/src/models/components/traditionalinvestingsignableactionresponse.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * Returned by prepare endpoints — contains EIP-712 typed data for the user to sign.
+ */
+export type TraditionalInvestingSignableActionResponse = {
+  /**
+   * EIP-712 typed data for wallet signing (domain, types, primaryType, message)
+   */
+  typedData: { [k: string]: any };
+  /**
+   * Raw Hyperliquid action (passed back to the execute endpoint)
+   */
+  action: { [k: string]: any };
+  /**
+   * Timestamp-based nonce used during signing
+   */
+  nonce: number;
+};
+
+/** @internal */
+export const TraditionalInvestingSignableActionResponse$inboundSchema:
+  z.ZodType<TraditionalInvestingSignableActionResponse, z.ZodTypeDef, unknown> =
+    z.object({
+      typed_data: z.record(z.any()),
+      action: z.record(z.any()),
+      nonce: z.number().int(),
+    }).transform((v) => {
+      return remap$(v, {
+        "typed_data": "typedData",
+      });
+    });
+
+export function traditionalInvestingSignableActionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  TraditionalInvestingSignableActionResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TraditionalInvestingSignableActionResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'TraditionalInvestingSignableActionResponse' from JSON`,
+  );
+}

package/src/models/components/traditionalinvestingwithdrawrequest.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Request to withdraw USDC from HyperEVM traditional investing account to Arbitrum.
+ */
+export type TraditionalInvestingWithdrawRequest = {
+  /**
+   * The user's EOA address (owner of the traditional investing account)
+   */
+  owner: string;
+  /**
+   * USDC amount to withdraw (human-readable, e.g. '500.0')
+   */
+  amount: string;
+  /**
+   * Arbitrum destination address (defaults to owner if not specified)
+   */
+  destination?: string | null | undefined;
+};
+
+/** @internal */
+export type TraditionalInvestingWithdrawRequest$Outbound = {
+  owner: string;
+  amount: string;
+  destination?: string | null | undefined;
+};
+
+/** @internal */
+export const TraditionalInvestingWithdrawRequest$outboundSchema: z.ZodType<
+  TraditionalInvestingWithdrawRequest$Outbound,
+  z.ZodTypeDef,
+  TraditionalInvestingWithdrawRequest
+> = z.object({
+  owner: z.string(),
+  amount: z.string(),
+  destination: z.nullable(z.string()).optional(),
+});
+
+export function traditionalInvestingWithdrawRequestToJSON(
+  traditionalInvestingWithdrawRequest: TraditionalInvestingWithdrawRequest,
+): string {
+  return JSON.stringify(
+    TraditionalInvestingWithdrawRequest$outboundSchema.parse(
+      traditionalInvestingWithdrawRequest,
+    ),
+  );
+}

package/src/models/operations/index.ts

@@ -49,5 +49,5 @@ export * from "./v2earnpendlemarkets.js";
 export * from "./v2earnpositions.js";
 export * from "./v2earnpositionsall.js";
 export * from "./v2earnvaults.js";
-export * from "./v2tradfiopportunities.js";
-export * from "./v2tradfipositions.js";
+export * from "./v2traditionalinvestingopportunities.js";
+export * from "./v2traditionalinvestingpositions.js";

package/src/models/operations/v2traditionalinvestingopportunities.ts

@@ -0,0 +1,112 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+import * as components from "../components/index.js";
+
+/**
+ * Sort results by this field
+ */
+export const TraditionalInvestingSortBy = {
+  OpenInterest: "open_interest",
+  Volume24h: "volume_24h",
+  FundingRate: "funding_rate",
+} as const;
+/**
+ * Sort results by this field
+ */
+export type TraditionalInvestingSortBy = ClosedEnum<
+  typeof TraditionalInvestingSortBy
+>;
+
+/**
+ * Sort direction
+ */
+export const TraditionalInvestingSortOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+/**
+ * Sort direction
+ */
+export type TraditionalInvestingSortOrder = ClosedEnum<
+  typeof TraditionalInvestingSortOrder
+>;
+
+export type V2TraditionalInvestingOpportunitiesRequest = {
+  /**
+   * Filter by minimum open interest in USD
+   */
+  minOpenInterest?: number | null | undefined;
+  /**
+   * Filter by minimum 24h volume in USD
+   */
+  minVolume24h?: number | null | undefined;
+  /**
+   * Filter by asset category: stock, commodity, forex
+   */
+  category?: components.TraditionalInvestingCategory | null | undefined;
+  /**
+   * Sort results by this field
+   */
+  sortBy?: TraditionalInvestingSortBy | undefined;
+  /**
+   * Sort direction
+   */
+  sortOrder?: TraditionalInvestingSortOrder | undefined;
+};
+
+/** @internal */
+export const TraditionalInvestingSortBy$outboundSchema: z.ZodNativeEnum<
+  typeof TraditionalInvestingSortBy
+> = z.nativeEnum(TraditionalInvestingSortBy);
+
+/** @internal */
+export const TraditionalInvestingSortOrder$outboundSchema: z.ZodNativeEnum<
+  typeof TraditionalInvestingSortOrder
+> = z.nativeEnum(TraditionalInvestingSortOrder);
+
+/** @internal */
+export type V2TraditionalInvestingOpportunitiesRequest$Outbound = {
+  min_open_interest?: number | null | undefined;
+  min_volume_24h?: number | null | undefined;
+  category?: string | null | undefined;
+  sort_by?: string | undefined;
+  sort_order?: string | undefined;
+};
+
+/** @internal */
+export const V2TraditionalInvestingOpportunitiesRequest$outboundSchema:
+  z.ZodType<
+    V2TraditionalInvestingOpportunitiesRequest$Outbound,
+    z.ZodTypeDef,
+    V2TraditionalInvestingOpportunitiesRequest
+  > = z.object({
+    minOpenInterest: z.nullable(z.number()).optional(),
+    minVolume24h: z.nullable(z.number()).optional(),
+    category: z.nullable(components.TraditionalInvestingCategory$outboundSchema)
+      .optional(),
+    sortBy: TraditionalInvestingSortBy$outboundSchema.optional(),
+    sortOrder: TraditionalInvestingSortOrder$outboundSchema.optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      minOpenInterest: "min_open_interest",
+      minVolume24h: "min_volume_24h",
+      sortBy: "sort_by",
+      sortOrder: "sort_order",
+    });
+  });
+
+export function v2TraditionalInvestingOpportunitiesRequestToJSON(
+  v2TraditionalInvestingOpportunitiesRequest:
+    V2TraditionalInvestingOpportunitiesRequest,
+): string {
+  return JSON.stringify(
+    V2TraditionalInvestingOpportunitiesRequest$outboundSchema.parse(
+      v2TraditionalInvestingOpportunitiesRequest,
+    ),
+  );
+}

package/src/models/operations/v2traditionalinvestingpositions.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type V2TraditionalInvestingPositionsRequest = {
+  /**
+   * User's EOA address (looks up their traditional investing product account)
+   */
+  owner: string;
+  /**
+   * Filter to a specific asset ticker (e.g. AAPL)
+   */
+  asset?: string | null | undefined;
+};
+
+/** @internal */
+export type V2TraditionalInvestingPositionsRequest$Outbound = {
+  owner: string;
+  asset?: string | null | undefined;
+};
+
+/** @internal */
+export const V2TraditionalInvestingPositionsRequest$outboundSchema: z.ZodType<
+  V2TraditionalInvestingPositionsRequest$Outbound,
+  z.ZodTypeDef,
+  V2TraditionalInvestingPositionsRequest
+> = z.object({
+  owner: z.string(),
+  asset: z.nullable(z.string()).optional(),
+});
+
+export function v2TraditionalInvestingPositionsRequestToJSON(
+  v2TraditionalInvestingPositionsRequest:
+    V2TraditionalInvestingPositionsRequest,
+): string {
+  return JSON.stringify(
+    V2TraditionalInvestingPositionsRequest$outboundSchema.parse(
+      v2TraditionalInvestingPositionsRequest,
+    ),
+  );
+}