@compass-labs/api-sdk 2.2.92 → 2.2.93

package/src/models/components/perpetualtradingensureleveragerequest.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Request to check and set leverage to 1x cross on a perpetual trading asset.
+ */
+export type PerpetualTradingEnsureLeverageRequest = {
+  /**
+   * User's EOA address
+   */
+  owner: string;
+  /**
+   * Asset ticker (e.g. 'AAPL', 'CL')
+   */
+  asset: string;
+};
+
+/** @internal */
+export type PerpetualTradingEnsureLeverageRequest$Outbound = {
+  owner: string;
+  asset: string;
+};
+
+/** @internal */
+export const PerpetualTradingEnsureLeverageRequest$outboundSchema: z.ZodType<
+  PerpetualTradingEnsureLeverageRequest$Outbound,
+  z.ZodTypeDef,
+  PerpetualTradingEnsureLeverageRequest
+> = z.object({
+  owner: z.string(),
+  asset: z.string(),
+});
+
+export function perpetualTradingEnsureLeverageRequestToJSON(
+  perpetualTradingEnsureLeverageRequest: PerpetualTradingEnsureLeverageRequest,
+): string {
+  return JSON.stringify(
+    PerpetualTradingEnsureLeverageRequest$outboundSchema.parse(
+      perpetualTradingEnsureLeverageRequest,
+    ),
+  );
+}

package/src/models/components/perpetualtradingensureleverageresponse.ts

@@ -0,0 +1,64 @@
+/*
+ * 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 ensure_leverage endpoint.
+ *
+ * @remarks
+ *
+ * If the asset is already at 1x cross leverage, typed_data/action/nonce are null.
+ * If not (or no position exists), they contain the EIP-712 payload the user must sign.
+ */
+export type PerpetualTradingEnsureLeverageResponse = {
+  /**
+   * True if leverage is already 1x cross, false if update needed
+   */
+  leverageOk: boolean;
+  /**
+   * EIP-712 typed data for wallet signing, or null if already 1x cross
+   */
+  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 PerpetualTradingEnsureLeverageResponse$inboundSchema: z.ZodType<
+  PerpetualTradingEnsureLeverageResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  leverage_ok: z.boolean(),
+  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, {
+    "leverage_ok": "leverageOk",
+    "typed_data": "typedData",
+  });
+});
+
+export function perpetualTradingEnsureLeverageResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PerpetualTradingEnsureLeverageResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PerpetualTradingEnsureLeverageResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PerpetualTradingEnsureLeverageResponse' from JSON`,
+  );
+}

package/src/models/components/perpetualtradingexecuterequest.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 PerpetualTradingExecuteRequest = {
+  /**
+   * 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 PerpetualTradingExecuteRequest$Outbound = {
+  action: { [k: string]: any };
+  nonce: number;
+  signature: string;
+  vault_address?: string | null | undefined;
+};
+
+/** @internal */
+export const PerpetualTradingExecuteRequest$outboundSchema: z.ZodType<
+  PerpetualTradingExecuteRequest$Outbound,
+  z.ZodTypeDef,
+  PerpetualTradingExecuteRequest
+> = 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 perpetualTradingExecuteRequestToJSON(
+  perpetualTradingExecuteRequest: PerpetualTradingExecuteRequest,
+): string {
+  return JSON.stringify(
+    PerpetualTradingExecuteRequest$outboundSchema.parse(
+      perpetualTradingExecuteRequest,
+    ),
+  );
+}

package/src/models/components/perpetualtradingexecuteresponse.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 PerpetualTradingExecuteResponse = {
+  /**
+   * 'ok' or 'error'
+   */
+  status: string;
+  /**
+   * Hyperliquid response data (order statuses, etc.)
+   */
+  response?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const PerpetualTradingExecuteResponse$inboundSchema: z.ZodType<
+  PerpetualTradingExecuteResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: z.string(),
+  response: z.record(z.any()).optional(),
+});
+
+export function perpetualTradingExecuteResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PerpetualTradingExecuteResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PerpetualTradingExecuteResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PerpetualTradingExecuteResponse' from JSON`,
+  );
+}

package/src/models/components/perpetualtradingfill.ts

@@ -0,0 +1,105 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Order side
+ */
+export const PerpetualTradingFillSide = {
+  Buy: "buy",
+  Sell: "sell",
+} as const;
+/**
+ * Order side
+ */
+export type PerpetualTradingFillSide = ClosedEnum<
+  typeof PerpetualTradingFillSide
+>;
+
+/**
+ * A single fill (executed trade) from HL `userFills`.
+ */
+export type PerpetualTradingFill = {
+  /**
+   * Asset ticker symbol (xyz prefix stripped)
+   */
+  asset: string;
+  /**
+   * Order side
+   */
+  side: PerpetualTradingFillSide;
+  /**
+   * Fill price
+   */
+  price: string;
+  /**
+   * Fill size in contracts
+   */
+  size: string;
+  /**
+   * Total fee paid (USDC)
+   */
+  fee: string;
+  /**
+   * Portion of fee routed to the builder address (USDC)
+   */
+  builderFee?: string | null | undefined;
+  /**
+   * Realized PnL closed by this fill (USDC)
+   */
+  closedPnl?: string | null | undefined;
+  /**
+   * HL order id (oid) this fill belongs to
+   */
+  orderId: number;
+  /**
+   * Fill timestamp (ms since epoch)
+   */
+  timeMs: number;
+};
+
+/** @internal */
+export const PerpetualTradingFillSide$inboundSchema: z.ZodNativeEnum<
+  typeof PerpetualTradingFillSide
+> = z.nativeEnum(PerpetualTradingFillSide);
+
+/** @internal */
+export const PerpetualTradingFill$inboundSchema: z.ZodType<
+  PerpetualTradingFill,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  asset: z.string(),
+  side: PerpetualTradingFillSide$inboundSchema,
+  price: z.string(),
+  size: z.string(),
+  fee: z.string(),
+  builder_fee: z.nullable(z.string()).optional(),
+  closed_pnl: z.nullable(z.string()).optional(),
+  order_id: z.number().int(),
+  time_ms: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "builder_fee": "builderFee",
+    "closed_pnl": "closedPnl",
+    "order_id": "orderId",
+    "time_ms": "timeMs",
+  });
+});
+
+export function perpetualTradingFillFromJSON(
+  jsonString: string,
+): SafeParseResult<PerpetualTradingFill, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PerpetualTradingFill$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PerpetualTradingFill' from JSON`,
+  );
+}

package/src/models/components/perpetualtradinglimitorderrequest.ts

@@ -0,0 +1,99 @@
+/*
+ * 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 {
+  Builder,
+  Builder$Outbound,
+  Builder$outboundSchema,
+} from "./builder.js";
+
+/**
+ * Request to place a limit order on a perpetual trading market.
+ */
+export type PerpetualTradingLimitOrderRequest = {
+  /**
+   * Owner of the perpetual trading product account
+   */
+  owner: string;
+  /**
+   * Asset ticker symbol (e.g. AAPL, GOLD, EUR)
+   */
+  asset: string;
+  /**
+   * Order side: 'buy' or 'sell'
+   */
+  side: string;
+  /**
+   * Number of contracts (human-readable)
+   */
+  size: string;
+  /**
+   * Limit price (human-readable)
+   */
+  price: string;
+  /**
+   * Time-in-force: 'gtc' (good til cancel) or 'alo' (add liquidity only)
+   */
+  timeInForce?: string | undefined;
+  /**
+   * If true, order can only reduce an existing position
+   */
+  reduceOnly?: boolean | undefined;
+  /**
+   * Optional client order ID for idempotency (uint128)
+   */
+  clientOrderId?: number | null | undefined;
+  /**
+   * Optional builder fee. When provided, the order action carries the builder address and fee — the end-user must have already approved this builder via /approve_builder_fee up to at least this rate. Omit (or pass null) to place the order with no builder fee.
+   */
+  builder?: Builder | null | undefined;
+};
+
+/** @internal */
+export type PerpetualTradingLimitOrderRequest$Outbound = {
+  owner: string;
+  asset: string;
+  side: string;
+  size: string;
+  price: string;
+  time_in_force?: string | undefined;
+  reduce_only?: boolean | undefined;
+  client_order_id?: number | null | undefined;
+  builder?: Builder$Outbound | null | undefined;
+};
+
+/** @internal */
+export const PerpetualTradingLimitOrderRequest$outboundSchema: z.ZodType<
+  PerpetualTradingLimitOrderRequest$Outbound,
+  z.ZodTypeDef,
+  PerpetualTradingLimitOrderRequest
+> = z.object({
+  owner: z.string(),
+  asset: z.string(),
+  side: z.string(),
+  size: z.string(),
+  price: z.string(),
+  timeInForce: z.string().optional(),
+  reduceOnly: z.boolean().optional(),
+  clientOrderId: z.nullable(z.number().int()).optional(),
+  builder: z.nullable(Builder$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    timeInForce: "time_in_force",
+    reduceOnly: "reduce_only",
+    clientOrderId: "client_order_id",
+  });
+});
+
+export function perpetualTradingLimitOrderRequestToJSON(
+  perpetualTradingLimitOrderRequest: PerpetualTradingLimitOrderRequest,
+): string {
+  return JSON.stringify(
+    PerpetualTradingLimitOrderRequest$outboundSchema.parse(
+      perpetualTradingLimitOrderRequest,
+    ),
+  );
+}

package/src/models/components/perpetualtradingmarketorderrequest.ts

@@ -0,0 +1,86 @@
+/*
+ * 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 {
+  Builder,
+  Builder$Outbound,
+  Builder$outboundSchema,
+} from "./builder.js";
+
+/**
+ * Request to place a market order on a perpetual trading market.
+ */
+export type PerpetualTradingMarketOrderRequest = {
+  /**
+   * Owner of the perpetual trading product account
+   */
+  owner: string;
+  /**
+   * Asset ticker symbol (e.g. AAPL, GOLD, EUR)
+   */
+  asset: string;
+  /**
+   * Order side: 'buy' or 'sell'
+   */
+  side: string;
+  /**
+   * Number of contracts (human-readable)
+   */
+  size: string;
+  /**
+   * Max slippage percentage for price protection
+   */
+  slippagePercent?: number | undefined;
+  /**
+   * If true, order can only reduce an existing position
+   */
+  reduceOnly?: boolean | undefined;
+  /**
+   * Optional builder fee. When provided, the order action carries the builder address and fee — the end-user must have already approved this builder via /approve_builder_fee up to at least this rate. Omit (or pass null) to place the order with no builder fee.
+   */
+  builder?: Builder | null | undefined;
+};
+
+/** @internal */
+export type PerpetualTradingMarketOrderRequest$Outbound = {
+  owner: string;
+  asset: string;
+  side: string;
+  size: string;
+  slippage_percent?: number | undefined;
+  reduce_only?: boolean | undefined;
+  builder?: Builder$Outbound | null | undefined;
+};
+
+/** @internal */
+export const PerpetualTradingMarketOrderRequest$outboundSchema: z.ZodType<
+  PerpetualTradingMarketOrderRequest$Outbound,
+  z.ZodTypeDef,
+  PerpetualTradingMarketOrderRequest
+> = z.object({
+  owner: z.string(),
+  asset: z.string(),
+  side: z.string(),
+  size: z.string(),
+  slippagePercent: z.number().optional(),
+  reduceOnly: z.boolean().optional(),
+  builder: z.nullable(Builder$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    slippagePercent: "slippage_percent",
+    reduceOnly: "reduce_only",
+  });
+});
+
+export function perpetualTradingMarketOrderRequestToJSON(
+  perpetualTradingMarketOrderRequest: PerpetualTradingMarketOrderRequest,
+): string {
+  return JSON.stringify(
+    PerpetualTradingMarketOrderRequest$outboundSchema.parse(
+      perpetualTradingMarketOrderRequest,
+    ),
+  );
+}

package/src/models/components/perpetualtradingopenorder.ts

@@ -0,0 +1,95 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Order side
+ */
+export const PerpetualTradingOpenOrderSide = {
+  Buy: "buy",
+  Sell: "sell",
+} as const;
+/**
+ * Order side
+ */
+export type PerpetualTradingOpenOrderSide = ClosedEnum<
+  typeof PerpetualTradingOpenOrderSide
+>;
+
+/**
+ * A single resting order from HL `openOrders`.
+ */
+export type PerpetualTradingOpenOrder = {
+  /**
+   * Asset ticker symbol (xyz prefix stripped)
+   */
+  asset: string;
+  /**
+   * Order side
+   */
+  side: PerpetualTradingOpenOrderSide;
+  /**
+   * Limit price
+   */
+  limitPrice: string;
+  /**
+   * Order size in contracts
+   */
+  size: string;
+  /**
+   * HL order id (oid)
+   */
+  orderId: number;
+  /**
+   * Order timestamp (ms since epoch)
+   */
+  timeMs: number;
+  /**
+   * True if order can only reduce position
+   */
+  reduceOnly: boolean;
+};
+
+/** @internal */
+export const PerpetualTradingOpenOrderSide$inboundSchema: z.ZodNativeEnum<
+  typeof PerpetualTradingOpenOrderSide
+> = z.nativeEnum(PerpetualTradingOpenOrderSide);
+
+/** @internal */
+export const PerpetualTradingOpenOrder$inboundSchema: z.ZodType<
+  PerpetualTradingOpenOrder,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  asset: z.string(),
+  side: PerpetualTradingOpenOrderSide$inboundSchema,
+  limit_price: z.string(),
+  size: z.string(),
+  order_id: z.number().int(),
+  time_ms: z.number().int(),
+  reduce_only: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "limit_price": "limitPrice",
+    "order_id": "orderId",
+    "time_ms": "timeMs",
+    "reduce_only": "reduceOnly",
+  });
+});
+
+export function perpetualTradingOpenOrderFromJSON(
+  jsonString: string,
+): SafeParseResult<PerpetualTradingOpenOrder, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PerpetualTradingOpenOrder$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PerpetualTradingOpenOrder' from JSON`,
+  );
+}

package/src/models/components/perpetualtradingopportunitiesresponse.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 {
+  PerpetualTradingOpportunity,
+  PerpetualTradingOpportunity$inboundSchema,
+} from "./perpetualtradingopportunity.js";
+
+/**
+ * List of available perpetual trading markets.
+ */
+export type PerpetualTradingOpportunitiesResponse = {
+  /**
+   * Available perpetual trading markets
+   */
+  opportunities: Array<PerpetualTradingOpportunity>;
+};
+
+/** @internal */
+export const PerpetualTradingOpportunitiesResponse$inboundSchema: z.ZodType<
+  PerpetualTradingOpportunitiesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  opportunities: z.array(PerpetualTradingOpportunity$inboundSchema),
+});
+
+export function perpetualTradingOpportunitiesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PerpetualTradingOpportunitiesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PerpetualTradingOpportunitiesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PerpetualTradingOpportunitiesResponse' from JSON`,
+  );
+}