@compass-labs/api-sdk 2.2.92-rc.0 → 2.2.93-rc.0

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

package/src/models/components/perpetualtradingopportunity.ts

@@ -0,0 +1,94 @@
+/*
+ * 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 perpetual trading market.
+ */
+export type PerpetualTradingOpportunity = {
+  /**
+   * 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 PerpetualTradingOpportunity$inboundSchema: z.ZodType<
+  PerpetualTradingOpportunity,
+  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 perpetualTradingOpportunityFromJSON(
+  jsonString: string,
+): SafeParseResult<PerpetualTradingOpportunity, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PerpetualTradingOpportunity$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PerpetualTradingOpportunity' from JSON`,
+  );
+}

package/src/models/components/perpetualtradingposition.ts

@@ -0,0 +1,118 @@
+/*
+ * 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";
+
+/**
+ * Position side: 'long' or 'short'
+ */
+export const PerpetualTradingPositionSide = {
+  Long: "long",
+  Short: "short",
+} as const;
+/**
+ * Position side: 'long' or 'short'
+ */
+export type PerpetualTradingPositionSide = ClosedEnum<
+  typeof PerpetualTradingPositionSide
+>;
+
+/**
+ * A single open perpetual futures position.
+ */
+export type PerpetualTradingPosition = {
+  /**
+   * Asset ticker symbol
+   */
+  asset: string;
+  /**
+   * Hyperliquid asset index
+   */
+  assetId: number;
+  /**
+   * Position side: 'long' or 'short'
+   */
+  side: PerpetualTradingPositionSide;
+  /**
+   * Position size in contracts
+   */
+  size: string;
+  /**
+   * Average entry price
+   */
+  entryPrice: string;
+  /**
+   * Current mark price
+   */
+  markPrice: string;
+  /**
+   * Estimated liquidation price
+   */
+  liquidationPrice?: string | null | undefined;
+  /**
+   * Unrealized PnL in USD
+   */
+  unrealizedPnl: string;
+  /**
+   * Current leverage
+   */
+  leverage: string;
+  /**
+   * Margin used for this position in USD
+   */
+  marginUsed: string;
+  /**
+   * Cumulative funding payments (negative = paid)
+   */
+  fundingAccrued: string;
+};
+
+/** @internal */
+export const PerpetualTradingPositionSide$inboundSchema: z.ZodNativeEnum<
+  typeof PerpetualTradingPositionSide
+> = z.nativeEnum(PerpetualTradingPositionSide);
+
+/** @internal */
+export const PerpetualTradingPosition$inboundSchema: z.ZodType<
+  PerpetualTradingPosition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  asset: z.string(),
+  asset_id: z.number().int(),
+  side: PerpetualTradingPositionSide$inboundSchema,
+  size: z.string(),
+  entry_price: z.string(),
+  mark_price: z.string(),
+  liquidation_price: z.nullable(z.string()).optional(),
+  unrealized_pnl: z.string(),
+  leverage: z.string(),
+  margin_used: z.string(),
+  funding_accrued: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "asset_id": "assetId",
+    "entry_price": "entryPrice",
+    "mark_price": "markPrice",
+    "liquidation_price": "liquidationPrice",
+    "unrealized_pnl": "unrealizedPnl",
+    "margin_used": "marginUsed",
+    "funding_accrued": "fundingAccrued",
+  });
+});
+
+export function perpetualTradingPositionFromJSON(
+  jsonString: string,
+): SafeParseResult<PerpetualTradingPosition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PerpetualTradingPosition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PerpetualTradingPosition' from JSON`,
+  );
+}

package/src/models/components/perpetualtradingpositionsresponse.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";
+import {
+  PerpetualTradingPosition,
+  PerpetualTradingPosition$inboundSchema,
+} from "./perpetualtradingposition.js";
+
+/**
+ * List of open perpetual trading positions with account balance.
+ */
+export type PerpetualTradingPositionsResponse = {
+  /**
+   * Open perpetual futures positions
+   */
+  positions: Array<PerpetualTradingPosition>;
+  /**
+   * Total account value in USD (margin + unrealized PnL)
+   */
+  accountValue?: string | undefined;
+  /**
+   * Available USDC balance (withdrawable margin)
+   */
+  withdrawable?: string | undefined;
+};
+
+/** @internal */
+export const PerpetualTradingPositionsResponse$inboundSchema: z.ZodType<
+  PerpetualTradingPositionsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  positions: z.array(PerpetualTradingPosition$inboundSchema),
+  account_value: z.string().optional(),
+  withdrawable: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "account_value": "accountValue",
+  });
+});
+
+export function perpetualTradingPositionsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PerpetualTradingPositionsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PerpetualTradingPositionsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PerpetualTradingPositionsResponse' from JSON`,
+  );
+}

package/src/models/components/perpetualtradingsetleveragerequest.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Request to set leverage on a perpetual trading asset.
+ *
+ * @remarks
+ *
+ * Omit ``leverage`` (or pass null) to target the asset's maximum leverage.
+ */
+export type PerpetualTradingSetLeverageRequest = {
+  /**
+   * User's EOA address
+   */
+  owner: string;
+  /**
+   * Asset ticker (e.g. 'AAPL', 'CL')
+   */
+  asset: string;
+  /**
+   * Target leverage as a whole-number multiplier. Omit (or pass null) to use the asset's maximum leverage. Must be between 1 and the asset's max leverage, which is available from the /opportunities endpoint.
+   */
+  leverage?: number | null | undefined;
+};
+
+/** @internal */
+export type PerpetualTradingSetLeverageRequest$Outbound = {
+  owner: string;
+  asset: string;
+  leverage?: number | null | undefined;
+};
+
+/** @internal */
+export const PerpetualTradingSetLeverageRequest$outboundSchema: z.ZodType<
+  PerpetualTradingSetLeverageRequest$Outbound,
+  z.ZodTypeDef,
+  PerpetualTradingSetLeverageRequest
+> = z.object({
+  owner: z.string(),
+  asset: z.string(),
+  leverage: z.nullable(z.number().int()).optional(),
+});
+
+export function perpetualTradingSetLeverageRequestToJSON(
+  perpetualTradingSetLeverageRequest: PerpetualTradingSetLeverageRequest,
+): string {
+  return JSON.stringify(
+    PerpetualTradingSetLeverageRequest$outboundSchema.parse(
+      perpetualTradingSetLeverageRequest,
+    ),
+  );
+}

package/src/models/components/perpetualtradingsetleverageresponse.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 set_leverage endpoint.
+ *
+ * @remarks
+ *
+ * If the asset is already at the requested leverage, typed_data/action/nonce
+ * are null. If not, they contain the EIP-712 payload the user must sign.
+ */
+export type PerpetualTradingSetLeverageResponse = {
+  /**
+   * True if leverage already matches the requested value, false if an update is needed
+   */
+  leverageOk: boolean;
+  /**
+   * EIP-712 typed data for wallet signing, or null if no change is needed
+   */
+  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 PerpetualTradingSetLeverageResponse$inboundSchema: z.ZodType<
+  PerpetualTradingSetLeverageResponse,
+  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 perpetualTradingSetLeverageResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PerpetualTradingSetLeverageResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PerpetualTradingSetLeverageResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PerpetualTradingSetLeverageResponse' from JSON`,
+  );
+}

package/src/models/components/perpetualtradingsignableactionresponse.ts

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

package/src/models/components/perpetualtradingwithdrawrequest.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 perpetual trading account to Arbitrum.
+ */
+export type PerpetualTradingWithdrawRequest = {
+  /**
+   * The user's EOA address (owner of the perpetual trading 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 PerpetualTradingWithdrawRequest$Outbound = {
+  owner: string;
+  amount: string;
+  destination?: string | null | undefined;
+};
+
+/** @internal */
+export const PerpetualTradingWithdrawRequest$outboundSchema: z.ZodType<
+  PerpetualTradingWithdrawRequest$Outbound,
+  z.ZodTypeDef,
+  PerpetualTradingWithdrawRequest
+> = z.object({
+  owner: z.string(),
+  amount: z.string(),
+  destination: z.nullable(z.string()).optional(),
+});
+
+export function perpetualTradingWithdrawRequestToJSON(
+  perpetualTradingWithdrawRequest: PerpetualTradingWithdrawRequest,
+): string {
+  return JSON.stringify(
+    PerpetualTradingWithdrawRequest$outboundSchema.parse(
+      perpetualTradingWithdrawRequest,
+    ),
+  );
+}

package/src/models/operations/index.ts

@@ -53,11 +53,11 @@ export * from "./v2earnpositions.js";
 export * from "./v2earnpositionsall.js";
 export * from "./v2earnswapquote.js";
 export * from "./v2earnvaults.js";
-export * from "./v2globalmarketsperpsactivity.js";
-export * from "./v2globalmarketsperpscandles.js";
-export * from "./v2globalmarketsperpsopportunities.js";
-export * from "./v2globalmarketsperpspositions.js";
 export * from "./v2onrampstatus.js";
+export * from "./v2perpetualtradingactivity.js";
+export * from "./v2perpetualtradingcandles.js";
+export * from "./v2perpetualtradingopportunities.js";
+export * from "./v2perpetualtradingpositions.js";
 export * from "./v2tokenizedassetsbalances.js";
 export * from "./v2tokenizedassetsmarkets.js";
 export * from "./v2tokenizedassetsmarketssymbol.js";

package/src/models/operations/v2perpetualtradingactivity.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type V2PerpetualTradingActivityRequest = {
+  /**
+   * End-user EOA whose activity should be fetched.
+   */
+  owner: string;
+  /**
+   * Optional builder address. When provided, the response includes the current builder-fee approval state for this (owner, builder) pair.
+   */
+  builder?: string | null | undefined;
+};
+
+/** @internal */
+export type V2PerpetualTradingActivityRequest$Outbound = {
+  owner: string;
+  builder?: string | null | undefined;
+};
+
+/** @internal */
+export const V2PerpetualTradingActivityRequest$outboundSchema: z.ZodType<
+  V2PerpetualTradingActivityRequest$Outbound,
+  z.ZodTypeDef,
+  V2PerpetualTradingActivityRequest
+> = z.object({
+  owner: z.string(),
+  builder: z.nullable(z.string()).optional(),
+});
+
+export function v2PerpetualTradingActivityRequestToJSON(
+  v2PerpetualTradingActivityRequest: V2PerpetualTradingActivityRequest,
+): string {
+  return JSON.stringify(
+    V2PerpetualTradingActivityRequest$outboundSchema.parse(
+      v2PerpetualTradingActivityRequest,
+    ),
+  );
+}

package/src/models/operations/v2perpetualtradingcandles.ts

@@ -0,0 +1,89 @@
+/*
+ * 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";
+
+/**
+ * Candle interval: 1m, 5m, 15m, 1h, 4h, 1d, 1w
+ */
+export const CandleInterval = {
+  Onem: "1m",
+  Fivem: "5m",
+  Fifteenm: "15m",
+  Oneh: "1h",
+  Fourh: "4h",
+  Oned: "1d",
+  Onew: "1w",
+} as const;
+/**
+ * Candle interval: 1m, 5m, 15m, 1h, 4h, 1d, 1w
+ */
+export type CandleInterval = ClosedEnum<typeof CandleInterval>;
+
+export type V2PerpetualTradingCandlesRequest = {
+  /**
+   * Asset ticker (e.g. AAPL, GOLD, EUR). The xyz: HIP-3 DEX prefix is added server-side if not already present.
+   */
+  symbol: string;
+  /**
+   * Candle interval: 1m, 5m, 15m, 1h, 4h, 1d, 1w
+   */
+  interval: CandleInterval;
+  /**
+   * Number of candles to return (max 5000, capped by Hyperliquid).
+   */
+  limit?: number | undefined;
+  /**
+   * Optional start of the candle window in unix milliseconds. If omitted, computed as end_time - limit * interval.
+   */
+  startTime?: number | null | undefined;
+  /**
+   * Optional end of the candle window in unix milliseconds. Defaults to now.
+   */
+  endTime?: number | null | undefined;
+};
+
+/** @internal */
+export const CandleInterval$outboundSchema: z.ZodNativeEnum<
+  typeof CandleInterval
+> = z.nativeEnum(CandleInterval);
+
+/** @internal */
+export type V2PerpetualTradingCandlesRequest$Outbound = {
+  symbol: string;
+  interval: string;
+  limit?: number | undefined;
+  start_time?: number | null | undefined;
+  end_time?: number | null | undefined;
+};
+
+/** @internal */
+export const V2PerpetualTradingCandlesRequest$outboundSchema: z.ZodType<
+  V2PerpetualTradingCandlesRequest$Outbound,
+  z.ZodTypeDef,
+  V2PerpetualTradingCandlesRequest
+> = z.object({
+  symbol: z.string(),
+  interval: CandleInterval$outboundSchema,
+  limit: z.number().int().optional(),
+  startTime: z.nullable(z.number().int()).optional(),
+  endTime: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    startTime: "start_time",
+    endTime: "end_time",
+  });
+});
+
+export function v2PerpetualTradingCandlesRequestToJSON(
+  v2PerpetualTradingCandlesRequest: V2PerpetualTradingCandlesRequest,
+): string {
+  return JSON.stringify(
+    V2PerpetualTradingCandlesRequest$outboundSchema.parse(
+      v2PerpetualTradingCandlesRequest,
+    ),
+  );
+}