@compass-labs/api-sdk 2.2.92 → 2.2.93

package/src/models/components/globalmarketsperpsensureleverageresponse.ts

@@ -1,69 +0,0 @@
-/*
- * 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 GlobalMarketsPerpsEnsureLeverageResponse = {
-  /**
-   * 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 GlobalMarketsPerpsEnsureLeverageResponse$inboundSchema: z.ZodType<
-  GlobalMarketsPerpsEnsureLeverageResponse,
-  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 globalMarketsPerpsEnsureLeverageResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<
-  GlobalMarketsPerpsEnsureLeverageResponse,
-  SDKValidationError
-> {
-  return safeParse(
-    jsonString,
-    (x) =>
-      GlobalMarketsPerpsEnsureLeverageResponse$inboundSchema.parse(
-        JSON.parse(x),
-      ),
-    `Failed to parse 'GlobalMarketsPerpsEnsureLeverageResponse' from JSON`,
-  );
-}

package/src/models/components/globalmarketsperpsexecuterequest.ts

@@ -1,62 +0,0 @@
-/*
- * 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 GlobalMarketsPerpsExecuteRequest = {
-  /**
-   * 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 GlobalMarketsPerpsExecuteRequest$Outbound = {
-  action: { [k: string]: any };
-  nonce: number;
-  signature: string;
-  vault_address?: string | null | undefined;
-};
-
-/** @internal */
-export const GlobalMarketsPerpsExecuteRequest$outboundSchema: z.ZodType<
-  GlobalMarketsPerpsExecuteRequest$Outbound,
-  z.ZodTypeDef,
-  GlobalMarketsPerpsExecuteRequest
-> = 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 globalMarketsPerpsExecuteRequestToJSON(
-  globalMarketsPerpsExecuteRequest: GlobalMarketsPerpsExecuteRequest,
-): string {
-  return JSON.stringify(
-    GlobalMarketsPerpsExecuteRequest$outboundSchema.parse(
-      globalMarketsPerpsExecuteRequest,
-    ),
-  );
-}

package/src/models/components/globalmarketsperpsexecuteresponse.ts

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

package/src/models/components/globalmarketsperpsfill.ts

@@ -1,105 +0,0 @@
-/*
- * 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 GlobalMarketsPerpsFillSide = {
-  Buy: "buy",
-  Sell: "sell",
-} as const;
-/**
- * Order side
- */
-export type GlobalMarketsPerpsFillSide = ClosedEnum<
-  typeof GlobalMarketsPerpsFillSide
->;
-
-/**
- * A single fill (executed trade) from HL `userFills`.
- */
-export type GlobalMarketsPerpsFill = {
-  /**
-   * Asset ticker symbol (xyz prefix stripped)
-   */
-  asset: string;
-  /**
-   * Order side
-   */
-  side: GlobalMarketsPerpsFillSide;
-  /**
-   * 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 GlobalMarketsPerpsFillSide$inboundSchema: z.ZodNativeEnum<
-  typeof GlobalMarketsPerpsFillSide
-> = z.nativeEnum(GlobalMarketsPerpsFillSide);
-
-/** @internal */
-export const GlobalMarketsPerpsFill$inboundSchema: z.ZodType<
-  GlobalMarketsPerpsFill,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  asset: z.string(),
-  side: GlobalMarketsPerpsFillSide$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 globalMarketsPerpsFillFromJSON(
-  jsonString: string,
-): SafeParseResult<GlobalMarketsPerpsFill, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => GlobalMarketsPerpsFill$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GlobalMarketsPerpsFill' from JSON`,
-  );
-}

package/src/models/components/globalmarketsperpslimitorderrequest.ts

@@ -1,99 +0,0 @@
-/*
- * 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 global markets perps market.
- */
-export type GlobalMarketsPerpsLimitOrderRequest = {
-  /**
-   * Owner of the global markets perps 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 GlobalMarketsPerpsLimitOrderRequest$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 GlobalMarketsPerpsLimitOrderRequest$outboundSchema: z.ZodType<
-  GlobalMarketsPerpsLimitOrderRequest$Outbound,
-  z.ZodTypeDef,
-  GlobalMarketsPerpsLimitOrderRequest
-> = 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 globalMarketsPerpsLimitOrderRequestToJSON(
-  globalMarketsPerpsLimitOrderRequest: GlobalMarketsPerpsLimitOrderRequest,
-): string {
-  return JSON.stringify(
-    GlobalMarketsPerpsLimitOrderRequest$outboundSchema.parse(
-      globalMarketsPerpsLimitOrderRequest,
-    ),
-  );
-}

package/src/models/components/globalmarketsperpsmarketorderrequest.ts

@@ -1,86 +0,0 @@
-/*
- * 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 global markets perps market.
- */
-export type GlobalMarketsPerpsMarketOrderRequest = {
-  /**
-   * Owner of the global markets perps 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 GlobalMarketsPerpsMarketOrderRequest$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 GlobalMarketsPerpsMarketOrderRequest$outboundSchema: z.ZodType<
-  GlobalMarketsPerpsMarketOrderRequest$Outbound,
-  z.ZodTypeDef,
-  GlobalMarketsPerpsMarketOrderRequest
-> = 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 globalMarketsPerpsMarketOrderRequestToJSON(
-  globalMarketsPerpsMarketOrderRequest: GlobalMarketsPerpsMarketOrderRequest,
-): string {
-  return JSON.stringify(
-    GlobalMarketsPerpsMarketOrderRequest$outboundSchema.parse(
-      globalMarketsPerpsMarketOrderRequest,
-    ),
-  );
-}

package/src/models/components/globalmarketsperpsopenorder.ts

@@ -1,95 +0,0 @@
-/*
- * 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 GlobalMarketsPerpsOpenOrderSide = {
-  Buy: "buy",
-  Sell: "sell",
-} as const;
-/**
- * Order side
- */
-export type GlobalMarketsPerpsOpenOrderSide = ClosedEnum<
-  typeof GlobalMarketsPerpsOpenOrderSide
->;
-
-/**
- * A single resting order from HL `openOrders`.
- */
-export type GlobalMarketsPerpsOpenOrder = {
-  /**
-   * Asset ticker symbol (xyz prefix stripped)
-   */
-  asset: string;
-  /**
-   * Order side
-   */
-  side: GlobalMarketsPerpsOpenOrderSide;
-  /**
-   * 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 GlobalMarketsPerpsOpenOrderSide$inboundSchema: z.ZodNativeEnum<
-  typeof GlobalMarketsPerpsOpenOrderSide
-> = z.nativeEnum(GlobalMarketsPerpsOpenOrderSide);
-
-/** @internal */
-export const GlobalMarketsPerpsOpenOrder$inboundSchema: z.ZodType<
-  GlobalMarketsPerpsOpenOrder,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  asset: z.string(),
-  side: GlobalMarketsPerpsOpenOrderSide$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 globalMarketsPerpsOpenOrderFromJSON(
-  jsonString: string,
-): SafeParseResult<GlobalMarketsPerpsOpenOrder, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => GlobalMarketsPerpsOpenOrder$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GlobalMarketsPerpsOpenOrder' from JSON`,
-  );
-}

package/src/models/components/globalmarketsperpsopportunitiesresponse.ts

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

package/src/models/components/globalmarketsperpsopportunity.ts

@@ -1,94 +0,0 @@
-/*
- * 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";
-
-/**
- * A single global markets perps market.
- */
-export type GlobalMarketsPerpsOpportunity = {
-  /**
-   * Asset ticker symbol (e.g. AAPL, GOLD, EUR)
-   */
-  asset: string;
-  /**
-   * Hyperliquid asset index
-   */
-  assetId: number;
-  /**
-   * Asset category: stock, commodity, forex
-   */
-  category: string;
-  /**
-   * Current mark price
-   */
-  markPrice: string;
-  /**
-   * Oracle reference price
-   */
-  oraclePrice: string;
-  /**
-   * Open interest in USD
-   */
-  openInterest: string;
-  /**
-   * 24-hour trading volume in USD
-   */
-  volume24h: string;
-  /**
-   * Current hourly funding rate
-   */
-  fundingRate: string;
-  /**
-   * Maximum allowed leverage
-   */
-  maxLeverage: number;
-  /**
-   * Size decimal places for order quantities
-   */
-  szDecimals: number;
-};
-
-/** @internal */
-export const GlobalMarketsPerpsOpportunity$inboundSchema: z.ZodType<
-  GlobalMarketsPerpsOpportunity,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  asset: z.string(),
-  asset_id: z.number().int(),
-  category: z.string(),
-  mark_price: z.string(),
-  oracle_price: z.string(),
-  open_interest: z.string(),
-  volume_24h: z.string(),
-  funding_rate: z.string(),
-  max_leverage: z.number().int(),
-  sz_decimals: z.number().int(),
-}).transform((v) => {
-  return remap$(v, {
-    "asset_id": "assetId",
-    "mark_price": "markPrice",
-    "oracle_price": "oraclePrice",
-    "open_interest": "openInterest",
-    "volume_24h": "volume24h",
-    "funding_rate": "fundingRate",
-    "max_leverage": "maxLeverage",
-    "sz_decimals": "szDecimals",
-  });
-});
-
-export function globalMarketsPerpsOpportunityFromJSON(
-  jsonString: string,
-): SafeParseResult<GlobalMarketsPerpsOpportunity, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => GlobalMarketsPerpsOpportunity$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GlobalMarketsPerpsOpportunity' from JSON`,
-  );
-}