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

package/src/models/components/{tradficancelorderrequest.ts → traditionalinvestingcancelorderrequest.ts}

@@ -6,11 +6,11 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 /**
- * Request to cancel an open order on a TradFi perp market.
+ * Request to cancel an open order on a traditional investing perp market.
  */
-export type TradFiCancelOrderRequest = {
+export type TraditionalInvestingCancelOrderRequest = {
   /**
-   * Owner of the TradFi product account
+   * Owner of the traditional investing product account
    */
   owner: string;
   /**
@@ -28,7 +28,7 @@ export type TradFiCancelOrderRequest = {
 };
 
 /** @internal */
-export type TradFiCancelOrderRequest$Outbound = {
+export type TraditionalInvestingCancelOrderRequest$Outbound = {
   owner: string;
   asset: string;
   order_id?: number | null | undefined;
@@ -36,10 +36,10 @@ export type TradFiCancelOrderRequest$Outbound = {
 };
 
 /** @internal */
-export const TradFiCancelOrderRequest$outboundSchema: z.ZodType<
-  TradFiCancelOrderRequest$Outbound,
+export const TraditionalInvestingCancelOrderRequest$outboundSchema: z.ZodType<
+  TraditionalInvestingCancelOrderRequest$Outbound,
   z.ZodTypeDef,
-  TradFiCancelOrderRequest
+  TraditionalInvestingCancelOrderRequest
 > = z.object({
   owner: z.string(),
   asset: z.string(),
@@ -52,10 +52,13 @@ export const TradFiCancelOrderRequest$outboundSchema: z.ZodType<
   });
 });
 
-export function tradFiCancelOrderRequestToJSON(
-  tradFiCancelOrderRequest: TradFiCancelOrderRequest,
+export function traditionalInvestingCancelOrderRequestToJSON(
+  traditionalInvestingCancelOrderRequest:
+    TraditionalInvestingCancelOrderRequest,
 ): string {
   return JSON.stringify(
-    TradFiCancelOrderRequest$outboundSchema.parse(tradFiCancelOrderRequest),
+    TraditionalInvestingCancelOrderRequest$outboundSchema.parse(
+      traditionalInvestingCancelOrderRequest,
+    ),
   );
 }

package/src/models/components/traditionalinvestingcategory.ts

@@ -0,0 +1,20 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const TraditionalInvestingCategory = {
+  Stock: "stock",
+  Commodity: "commodity",
+  Forex: "forex",
+} as const;
+export type TraditionalInvestingCategory = ClosedEnum<
+  typeof TraditionalInvestingCategory
+>;
+
+/** @internal */
+export const TraditionalInvestingCategory$outboundSchema: z.ZodNativeEnum<
+  typeof TraditionalInvestingCategory
+> = z.nativeEnum(TraditionalInvestingCategory);

package/src/models/components/traditionalinvestingdepositrequest.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Request to deposit USDC from Arbitrum into the user's traditional investing account.
+ */
+export type TraditionalInvestingDepositRequest = {
+  /**
+   * The user's EOA address on Arbitrum
+   */
+  owner: string;
+  /**
+   * USDC amount to deposit (human-readable, e.g. '1000.0')
+   */
+  amount: string;
+};
+
+/** @internal */
+export type TraditionalInvestingDepositRequest$Outbound = {
+  owner: string;
+  amount: string;
+};
+
+/** @internal */
+export const TraditionalInvestingDepositRequest$outboundSchema: z.ZodType<
+  TraditionalInvestingDepositRequest$Outbound,
+  z.ZodTypeDef,
+  TraditionalInvestingDepositRequest
+> = z.object({
+  owner: z.string(),
+  amount: z.string(),
+});
+
+export function traditionalInvestingDepositRequestToJSON(
+  traditionalInvestingDepositRequest: TraditionalInvestingDepositRequest,
+): string {
+  return JSON.stringify(
+    TraditionalInvestingDepositRequest$outboundSchema.parse(
+      traditionalInvestingDepositRequest,
+    ),
+  );
+}

package/src/models/components/traditionalinvestingdepositresponse.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";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PermitTypedDataResponseOutput,
+  PermitTypedDataResponseOutput$inboundSchema,
+} from "./permittypeddataresponseoutput.js";
+
+/**
+ * EIP-2612 permit data for the user to sign, plus deposit metadata.
+ *
+ * @remarks
+ *
+ * After the user signs the permit, the gas sponsor calls
+ * batchedDepositWithPermit on the Hyperliquid Bridge2 contract.
+ */
+export type TraditionalInvestingDepositResponse = {
+  /**
+   * Response containing EIP-712 typed data for ERC-20 Permit signing.
+   */
+  permit: PermitTypedDataResponseOutput;
+  /**
+   * USDC amount in raw units (6 decimals)
+   */
+  amountRaw: number;
+  /**
+   * Traditional investing Safe address on HyperEVM that receives the deposit on HyperCore
+   */
+  destination: string;
+};
+
+/** @internal */
+export const TraditionalInvestingDepositResponse$inboundSchema: z.ZodType<
+  TraditionalInvestingDepositResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  permit: PermitTypedDataResponseOutput$inboundSchema,
+  amount_raw: z.number().int(),
+  destination: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "amount_raw": "amountRaw",
+  });
+});
+
+export function traditionalInvestingDepositResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TraditionalInvestingDepositResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TraditionalInvestingDepositResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TraditionalInvestingDepositResponse' from JSON`,
+  );
+}

package/src/models/components/traditionalinvestingenableunifiedaccountrequest.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Request to enable unified account mode on Hyperliquid.
+ */
+export type TraditionalInvestingEnableUnifiedAccountRequest = {
+  /**
+   * User's EOA address
+   */
+  owner: string;
+};
+
+/** @internal */
+export type TraditionalInvestingEnableUnifiedAccountRequest$Outbound = {
+  owner: string;
+};
+
+/** @internal */
+export const TraditionalInvestingEnableUnifiedAccountRequest$outboundSchema:
+  z.ZodType<
+    TraditionalInvestingEnableUnifiedAccountRequest$Outbound,
+    z.ZodTypeDef,
+    TraditionalInvestingEnableUnifiedAccountRequest
+  > = z.object({
+    owner: z.string(),
+  });
+
+export function traditionalInvestingEnableUnifiedAccountRequestToJSON(
+  traditionalInvestingEnableUnifiedAccountRequest:
+    TraditionalInvestingEnableUnifiedAccountRequest,
+): string {
+  return JSON.stringify(
+    TraditionalInvestingEnableUnifiedAccountRequest$outboundSchema.parse(
+      traditionalInvestingEnableUnifiedAccountRequest,
+    ),
+  );
+}

package/src/models/components/traditionalinvestingenableunifiedaccountresponse.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 the enable_unified_account endpoint.
+ *
+ * @remarks
+ *
+ * If the account is already in unified mode, typed_data/action/nonce are null.
+ * If not, they contain the EIP-712 payload the user must sign.
+ */
+export type TraditionalInvestingEnableUnifiedAccountResponse = {
+  /**
+   * Current account abstraction mode (e.g. 'default', 'unifiedAccount')
+   */
+  mode: string;
+  /**
+   * EIP-712 typed data for wallet signing, or null if already unified
+   */
+  typedData?: { [k: string]: any } | null | undefined;
+  /**
+   * Raw Hyperliquid action (passed back to the execute endpoint), or null
+   */
+  action?: { [k: string]: any } | null | undefined;
+  /**
+   * Timestamp-based nonce, or null if no action needed
+   */
+  nonce?: number | null | undefined;
+};
+
+/** @internal */
+export const TraditionalInvestingEnableUnifiedAccountResponse$inboundSchema:
+  z.ZodType<
+    TraditionalInvestingEnableUnifiedAccountResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    mode: z.string(),
+    typed_data: z.nullable(z.record(z.any())).optional(),
+    action: z.nullable(z.record(z.any())).optional(),
+    nonce: z.nullable(z.number().int()).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "typed_data": "typedData",
+    });
+  });
+
+export function traditionalInvestingEnableUnifiedAccountResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  TraditionalInvestingEnableUnifiedAccountResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TraditionalInvestingEnableUnifiedAccountResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'TraditionalInvestingEnableUnifiedAccountResponse' from JSON`,
+  );
+}

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