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

package/src/models/components/perpetualtradingactivityresponse.ts

@@ -0,0 +1,109 @@
+/*
+ * 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 {
+  PerpetualTradingActivityPartialError,
+  PerpetualTradingActivityPartialError$inboundSchema,
+} from "./perpetualtradingactivitypartialerror.js";
+import {
+  PerpetualTradingBuilderApproval,
+  PerpetualTradingBuilderApproval$inboundSchema,
+} from "./perpetualtradingbuilderapproval.js";
+import {
+  PerpetualTradingFill,
+  PerpetualTradingFill$inboundSchema,
+} from "./perpetualtradingfill.js";
+import {
+  PerpetualTradingOpenOrder,
+  PerpetualTradingOpenOrder$inboundSchema,
+} from "./perpetualtradingopenorder.js";
+import {
+  PerpetualTradingPosition,
+  PerpetualTradingPosition$inboundSchema,
+} from "./perpetualtradingposition.js";
+
+/**
+ * Aggregated HL activity for a single end-user.
+ *
+ * @remarks
+ *
+ * Any section may be ``null`` if its upstream HL call failed — see
+ * ``partial_errors`` for details. ``positions``/``fills``/``open_orders``
+ * are always either a populated list or ``null``; an empty list means the
+ * user has no activity of that type, not a failure.
+ */
+export type PerpetualTradingActivityResponse = {
+  /**
+   * Owner address that was queried (checksummed)
+   */
+  owner: string;
+  /**
+   * Open positions (null if the upstream call failed)
+   */
+  positions: Array<PerpetualTradingPosition> | null;
+  /**
+   * Total account value in USDC (null if positions failed)
+   */
+  accountValue: string | null;
+  /**
+   * Withdrawable USDC balance (null if positions failed)
+   */
+  withdrawable: string | null;
+  /**
+   * Recent fills (null if the upstream call failed)
+   */
+  fills: Array<PerpetualTradingFill> | null;
+  /**
+   * Resting orders (null if the upstream call failed)
+   */
+  openOrders: Array<PerpetualTradingOpenOrder> | null;
+  /**
+   * Builder approval state — only present when the `builder` query parameter was supplied (null on upstream failure).
+   */
+  builderApproval?: PerpetualTradingBuilderApproval | null | undefined;
+  /**
+   * One entry per section that failed to load.
+   */
+  partialErrors?: Array<PerpetualTradingActivityPartialError> | undefined;
+};
+
+/** @internal */
+export const PerpetualTradingActivityResponse$inboundSchema: z.ZodType<
+  PerpetualTradingActivityResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  owner: z.string(),
+  positions: z.nullable(z.array(PerpetualTradingPosition$inboundSchema)),
+  account_value: z.nullable(z.string()),
+  withdrawable: z.nullable(z.string()),
+  fills: z.nullable(z.array(PerpetualTradingFill$inboundSchema)),
+  open_orders: z.nullable(z.array(PerpetualTradingOpenOrder$inboundSchema)),
+  builder_approval: z.nullable(PerpetualTradingBuilderApproval$inboundSchema)
+    .optional(),
+  partial_errors: z.array(PerpetualTradingActivityPartialError$inboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "account_value": "accountValue",
+    "open_orders": "openOrders",
+    "builder_approval": "builderApproval",
+    "partial_errors": "partialErrors",
+  });
+});
+
+export function perpetualTradingActivityResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PerpetualTradingActivityResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PerpetualTradingActivityResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PerpetualTradingActivityResponse' from JSON`,
+  );
+}

package/src/models/components/perpetualtradingapprovebuilderfeerequest.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  Builder,
+  Builder$Outbound,
+  Builder$outboundSchema,
+} from "./builder.js";
+
+/**
+ * Request to approve builder fees before trading on the perpetual trading DEX.
+ */
+export type PerpetualTradingApproveBuilderFeeRequest = {
+  /**
+   * User's EOA address
+   */
+  owner: string;
+  /**
+   * Builder address + max fee rate the end-user authorizes.
+   */
+  builder: Builder;
+};
+
+/** @internal */
+export type PerpetualTradingApproveBuilderFeeRequest$Outbound = {
+  owner: string;
+  builder: Builder$Outbound;
+};
+
+/** @internal */
+export const PerpetualTradingApproveBuilderFeeRequest$outboundSchema: z.ZodType<
+  PerpetualTradingApproveBuilderFeeRequest$Outbound,
+  z.ZodTypeDef,
+  PerpetualTradingApproveBuilderFeeRequest
+> = z.object({
+  owner: z.string(),
+  builder: Builder$outboundSchema,
+});
+
+export function perpetualTradingApproveBuilderFeeRequestToJSON(
+  perpetualTradingApproveBuilderFeeRequest:
+    PerpetualTradingApproveBuilderFeeRequest,
+): string {
+  return JSON.stringify(
+    PerpetualTradingApproveBuilderFeeRequest$outboundSchema.parse(
+      perpetualTradingApproveBuilderFeeRequest,
+    ),
+  );
+}

package/src/models/components/perpetualtradingbuilderapproval.ts

@@ -0,0 +1,52 @@
+/*
+ * 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";
+
+/**
+ * Current builder-fee approval state for a (user, builder) pair.
+ */
+export type PerpetualTradingBuilderApproval = {
+  /**
+   * Builder address that was queried
+   */
+  builder: string;
+  /**
+   * Maximum fee rate the user has approved for this builder, in tenths of basis points (10 = 1bp = 0.01%). Zero means the user has not approved.
+   */
+  maxFeeTenthBps: number;
+  /**
+   * Convenience flag — true when max_fee_tenth_bps > 0
+   */
+  approved: boolean;
+};
+
+/** @internal */
+export const PerpetualTradingBuilderApproval$inboundSchema: z.ZodType<
+  PerpetualTradingBuilderApproval,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  builder: z.string(),
+  max_fee_tenth_bps: z.number().int(),
+  approved: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "max_fee_tenth_bps": "maxFeeTenthBps",
+  });
+});
+
+export function perpetualTradingBuilderApprovalFromJSON(
+  jsonString: string,
+): SafeParseResult<PerpetualTradingBuilderApproval, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PerpetualTradingBuilderApproval$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PerpetualTradingBuilderApproval' from JSON`,
+  );
+}

package/src/models/components/perpetualtradingcancelorderrequest.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+/**
+ * Request to cancel an open order on a perpetual trading market.
+ */
+export type PerpetualTradingCancelOrderRequest = {
+  /**
+   * Owner of the perpetual trading product account
+   */
+  owner: string;
+  /**
+   * Asset ticker symbol (e.g. AAPL, GOLD, EUR)
+   */
+  asset: string;
+  /**
+   * Hyperliquid order ID to cancel
+   */
+  orderId?: number | null | undefined;
+  /**
+   * Client order ID to cancel (alternative to order_id)
+   */
+  clientOrderId?: number | null | undefined;
+};
+
+/** @internal */
+export type PerpetualTradingCancelOrderRequest$Outbound = {
+  owner: string;
+  asset: string;
+  order_id?: number | null | undefined;
+  client_order_id?: number | null | undefined;
+};
+
+/** @internal */
+export const PerpetualTradingCancelOrderRequest$outboundSchema: z.ZodType<
+  PerpetualTradingCancelOrderRequest$Outbound,
+  z.ZodTypeDef,
+  PerpetualTradingCancelOrderRequest
+> = z.object({
+  owner: z.string(),
+  asset: z.string(),
+  orderId: z.nullable(z.number().int()).optional(),
+  clientOrderId: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    orderId: "order_id",
+    clientOrderId: "client_order_id",
+  });
+});
+
+export function perpetualTradingCancelOrderRequestToJSON(
+  perpetualTradingCancelOrderRequest: PerpetualTradingCancelOrderRequest,
+): string {
+  return JSON.stringify(
+    PerpetualTradingCancelOrderRequest$outboundSchema.parse(
+      perpetualTradingCancelOrderRequest,
+    ),
+  );
+}

package/src/models/components/perpetualtradingcandlesresponse.ts

@@ -0,0 +1,48 @@
+/*
+ * 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 { Candle, Candle$inboundSchema } from "./candle.js";
+
+/**
+ * OHLCV candle series for a single asset/interval.
+ */
+export type PerpetualTradingCandlesResponse = {
+  /**
+   * Asset ticker the candles are for (without DEX prefix)
+   */
+  symbol: string;
+  /**
+   * Candle interval that was requested
+   */
+  interval: string;
+  /**
+   * Candles ordered oldest → newest
+   */
+  candles: Array<Candle>;
+};
+
+/** @internal */
+export const PerpetualTradingCandlesResponse$inboundSchema: z.ZodType<
+  PerpetualTradingCandlesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  symbol: z.string(),
+  interval: z.string(),
+  candles: z.array(Candle$inboundSchema),
+});
+
+export function perpetualTradingCandlesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PerpetualTradingCandlesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PerpetualTradingCandlesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PerpetualTradingCandlesResponse' from JSON`,
+  );
+}

package/src/models/components/perpetualtradingcategory.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 PerpetualTradingCategory = {
+  Stock: "stock",
+  Commodity: "commodity",
+  Forex: "forex",
+} as const;
+export type PerpetualTradingCategory = ClosedEnum<
+  typeof PerpetualTradingCategory
+>;
+
+/** @internal */
+export const PerpetualTradingCategory$outboundSchema: z.ZodNativeEnum<
+  typeof PerpetualTradingCategory
+> = z.nativeEnum(PerpetualTradingCategory);

package/src/models/components/perpetualtradingdepositrequest.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 perpetual trading account.
+ */
+export type PerpetualTradingDepositRequest = {
+  /**
+   * The user's EOA address on Arbitrum
+   */
+  owner: string;
+  /**
+   * USDC amount to deposit (human-readable, e.g. '1000.0')
+   */
+  amount: string;
+};
+
+/** @internal */
+export type PerpetualTradingDepositRequest$Outbound = {
+  owner: string;
+  amount: string;
+};
+
+/** @internal */
+export const PerpetualTradingDepositRequest$outboundSchema: z.ZodType<
+  PerpetualTradingDepositRequest$Outbound,
+  z.ZodTypeDef,
+  PerpetualTradingDepositRequest
+> = z.object({
+  owner: z.string(),
+  amount: z.string(),
+});
+
+export function perpetualTradingDepositRequestToJSON(
+  perpetualTradingDepositRequest: PerpetualTradingDepositRequest,
+): string {
+  return JSON.stringify(
+    PerpetualTradingDepositRequest$outboundSchema.parse(
+      perpetualTradingDepositRequest,
+    ),
+  );
+}

package/src/models/components/perpetualtradingdepositresponse.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 the user signs to authorize a USDC bridge deposit.
+ *
+ * @remarks
+ *
+ * After signing, submit the signature to /v2/perpetual_trading/deposit/sponsor_prepare
+ * to get a ready-to-broadcast Arbitrum tx that calls Bridge2.batchedDepositWithPermit.
+ * The integrator's sponsor wallet broadcasts that tx — Compass does not broadcast.
+ */
+export type PerpetualTradingDepositResponse = {
+  /**
+   * Response containing EIP-712 typed data for ERC-20 Permit signing.
+   */
+  permit: PermitTypedDataResponseOutput;
+  /**
+   * USDC amount in raw 6-decimal units. Pass this and the signature to /deposit/sponsor_prepare.
+   */
+  amountRaw: number;
+  /**
+   * Address that will be credited on Hyperliquid (equals the deposit owner EOA — HL keys accounts by EVM address).
+   */
+  destination: string;
+};
+
+/** @internal */
+export const PerpetualTradingDepositResponse$inboundSchema: z.ZodType<
+  PerpetualTradingDepositResponse,
+  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 perpetualTradingDepositResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PerpetualTradingDepositResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PerpetualTradingDepositResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PerpetualTradingDepositResponse' from JSON`,
+  );
+}

package/src/models/components/perpetualtradingdepositsponsorpreparerequest.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+/**
+ * Take a user's signed EIP-2612 USDC permit and build an Arbitrum tx
+ *
+ * @remarks
+ * that calls Bridge2.batchedDepositWithPermit.
+ *
+ * The customer broadcasts the returned tx from their own sponsor wallet —
+ * Compass does not hold gas keys (non-custodial).
+ */
+export type PerpetualTradingDepositSponsorPrepareRequest = {
+  /**
+   * The user's EOA address on Arbitrum (the permit signer).
+   */
+  owner: string;
+  /**
+   * USDC amount in raw 6-decimal units, as returned by /deposit.
+   */
+  amountRaw: number;
+  /**
+   * Permit deadline (unix seconds), as returned in the permit.message from /deposit.
+   */
+  deadline: number;
+  /**
+   * The user's EIP-2612 permit signature (65-byte hex, 0x-prefixed or raw).
+   */
+  signature: string;
+  /**
+   * Sponsor wallet address that will broadcast the returned tx (used for `from` and nonce).
+   */
+  sender: string;
+};
+
+/** @internal */
+export type PerpetualTradingDepositSponsorPrepareRequest$Outbound = {
+  owner: string;
+  amount_raw: number;
+  deadline: number;
+  signature: string;
+  sender: string;
+};
+
+/** @internal */
+export const PerpetualTradingDepositSponsorPrepareRequest$outboundSchema:
+  z.ZodType<
+    PerpetualTradingDepositSponsorPrepareRequest$Outbound,
+    z.ZodTypeDef,
+    PerpetualTradingDepositSponsorPrepareRequest
+  > = z.object({
+    owner: z.string(),
+    amountRaw: z.number().int(),
+    deadline: z.number().int(),
+    signature: z.string(),
+    sender: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      amountRaw: "amount_raw",
+    });
+  });
+
+export function perpetualTradingDepositSponsorPrepareRequestToJSON(
+  perpetualTradingDepositSponsorPrepareRequest:
+    PerpetualTradingDepositSponsorPrepareRequest,
+): string {
+  return JSON.stringify(
+    PerpetualTradingDepositSponsorPrepareRequest$outboundSchema.parse(
+      perpetualTradingDepositSponsorPrepareRequest,
+    ),
+  );
+}

package/src/models/components/perpetualtradingdepositsponsorprepareresponse.ts

@@ -0,0 +1,51 @@
+/*
+ * 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 {
+  UnsignedTransaction,
+  UnsignedTransaction$inboundSchema,
+} from "./unsignedtransaction.js";
+
+/**
+ * Fully-encoded Arbitrum tx that completes a HL Bridge2 deposit.
+ *
+ * @remarks
+ *
+ * Broadcast `transaction` from the `sender` wallet supplied in the request.
+ * After the receipt confirms, verify a USDC `Transfer` event was emitted —
+ * Bridge2 can silently no-op without reverting.
+ */
+export type PerpetualTradingDepositSponsorPrepareResponse = {
+  transaction: UnsignedTransaction;
+};
+
+/** @internal */
+export const PerpetualTradingDepositSponsorPrepareResponse$inboundSchema:
+  z.ZodType<
+    PerpetualTradingDepositSponsorPrepareResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    transaction: UnsignedTransaction$inboundSchema,
+  });
+
+export function perpetualTradingDepositSponsorPrepareResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PerpetualTradingDepositSponsorPrepareResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PerpetualTradingDepositSponsorPrepareResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PerpetualTradingDepositSponsorPrepareResponse' from JSON`,
+  );
+}

package/src/models/components/perpetualtradingenableunifiedaccountrequest.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 PerpetualTradingEnableUnifiedAccountRequest = {
+  /**
+   * User's EOA address
+   */
+  owner: string;
+};
+
+/** @internal */
+export type PerpetualTradingEnableUnifiedAccountRequest$Outbound = {
+  owner: string;
+};
+
+/** @internal */
+export const PerpetualTradingEnableUnifiedAccountRequest$outboundSchema:
+  z.ZodType<
+    PerpetualTradingEnableUnifiedAccountRequest$Outbound,
+    z.ZodTypeDef,
+    PerpetualTradingEnableUnifiedAccountRequest
+  > = z.object({
+    owner: z.string(),
+  });
+
+export function perpetualTradingEnableUnifiedAccountRequestToJSON(
+  perpetualTradingEnableUnifiedAccountRequest:
+    PerpetualTradingEnableUnifiedAccountRequest,
+): string {
+  return JSON.stringify(
+    PerpetualTradingEnableUnifiedAccountRequest$outboundSchema.parse(
+      perpetualTradingEnableUnifiedAccountRequest,
+    ),
+  );
+}

package/src/models/components/perpetualtradingenableunifiedaccountresponse.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 PerpetualTradingEnableUnifiedAccountResponse = {
+  /**
+   * 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 PerpetualTradingEnableUnifiedAccountResponse$inboundSchema:
+  z.ZodType<
+    PerpetualTradingEnableUnifiedAccountResponse,
+    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 perpetualTradingEnableUnifiedAccountResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PerpetualTradingEnableUnifiedAccountResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PerpetualTradingEnableUnifiedAccountResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PerpetualTradingEnableUnifiedAccountResponse' from JSON`,
+  );
+}