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

package/src/models/components/globalmarketsperpsapprovebuilderfeerequest.ts

@@ -1,52 +0,0 @@
-/*
- * 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 global markets perps DEX.
- */
-export type GlobalMarketsPerpsApproveBuilderFeeRequest = {
-  /**
-   * User's EOA address
-   */
-  owner: string;
-  /**
-   * Builder address + max fee rate the end-user authorizes.
-   */
-  builder: Builder;
-};
-
-/** @internal */
-export type GlobalMarketsPerpsApproveBuilderFeeRequest$Outbound = {
-  owner: string;
-  builder: Builder$Outbound;
-};
-
-/** @internal */
-export const GlobalMarketsPerpsApproveBuilderFeeRequest$outboundSchema:
-  z.ZodType<
-    GlobalMarketsPerpsApproveBuilderFeeRequest$Outbound,
-    z.ZodTypeDef,
-    GlobalMarketsPerpsApproveBuilderFeeRequest
-  > = z.object({
-    owner: z.string(),
-    builder: Builder$outboundSchema,
-  });
-
-export function globalMarketsPerpsApproveBuilderFeeRequestToJSON(
-  globalMarketsPerpsApproveBuilderFeeRequest:
-    GlobalMarketsPerpsApproveBuilderFeeRequest,
-): string {
-  return JSON.stringify(
-    GlobalMarketsPerpsApproveBuilderFeeRequest$outboundSchema.parse(
-      globalMarketsPerpsApproveBuilderFeeRequest,
-    ),
-  );
-}

package/src/models/components/globalmarketsperpsbuilderapproval.ts

@@ -1,52 +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";
-
-/**
- * Current builder-fee approval state for a (user, builder) pair.
- */
-export type GlobalMarketsPerpsBuilderApproval = {
-  /**
-   * 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 GlobalMarketsPerpsBuilderApproval$inboundSchema: z.ZodType<
-  GlobalMarketsPerpsBuilderApproval,
-  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 globalMarketsPerpsBuilderApprovalFromJSON(
-  jsonString: string,
-): SafeParseResult<GlobalMarketsPerpsBuilderApproval, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => GlobalMarketsPerpsBuilderApproval$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GlobalMarketsPerpsBuilderApproval' from JSON`,
-  );
-}

package/src/models/components/globalmarketsperpscancelorderrequest.ts

@@ -1,63 +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";
-
-/**
- * Request to cancel an open order on a global markets perps market.
- */
-export type GlobalMarketsPerpsCancelOrderRequest = {
-  /**
-   * Owner of the global markets perps 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 GlobalMarketsPerpsCancelOrderRequest$Outbound = {
-  owner: string;
-  asset: string;
-  order_id?: number | null | undefined;
-  client_order_id?: number | null | undefined;
-};
-
-/** @internal */
-export const GlobalMarketsPerpsCancelOrderRequest$outboundSchema: z.ZodType<
-  GlobalMarketsPerpsCancelOrderRequest$Outbound,
-  z.ZodTypeDef,
-  GlobalMarketsPerpsCancelOrderRequest
-> = 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 globalMarketsPerpsCancelOrderRequestToJSON(
-  globalMarketsPerpsCancelOrderRequest: GlobalMarketsPerpsCancelOrderRequest,
-): string {
-  return JSON.stringify(
-    GlobalMarketsPerpsCancelOrderRequest$outboundSchema.parse(
-      globalMarketsPerpsCancelOrderRequest,
-    ),
-  );
-}

package/src/models/components/globalmarketsperpscandlesresponse.ts

@@ -1,48 +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 { Candle, Candle$inboundSchema } from "./candle.js";
-
-/**
- * OHLCV candle series for a single asset/interval.
- */
-export type GlobalMarketsPerpsCandlesResponse = {
-  /**
-   * 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 GlobalMarketsPerpsCandlesResponse$inboundSchema: z.ZodType<
-  GlobalMarketsPerpsCandlesResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  symbol: z.string(),
-  interval: z.string(),
-  candles: z.array(Candle$inboundSchema),
-});
-
-export function globalMarketsPerpsCandlesResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<GlobalMarketsPerpsCandlesResponse, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => GlobalMarketsPerpsCandlesResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GlobalMarketsPerpsCandlesResponse' from JSON`,
-  );
-}

package/src/models/components/globalmarketsperpscategory.ts

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

package/src/models/components/globalmarketsperpsdepositrequest.ts

@@ -1,45 +0,0 @@
-/*
- * 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 global markets perps account.
- */
-export type GlobalMarketsPerpsDepositRequest = {
-  /**
-   * The user's EOA address on Arbitrum
-   */
-  owner: string;
-  /**
-   * USDC amount to deposit (human-readable, e.g. '1000.0')
-   */
-  amount: string;
-};
-
-/** @internal */
-export type GlobalMarketsPerpsDepositRequest$Outbound = {
-  owner: string;
-  amount: string;
-};
-
-/** @internal */
-export const GlobalMarketsPerpsDepositRequest$outboundSchema: z.ZodType<
-  GlobalMarketsPerpsDepositRequest$Outbound,
-  z.ZodTypeDef,
-  GlobalMarketsPerpsDepositRequest
-> = z.object({
-  owner: z.string(),
-  amount: z.string(),
-});
-
-export function globalMarketsPerpsDepositRequestToJSON(
-  globalMarketsPerpsDepositRequest: GlobalMarketsPerpsDepositRequest,
-): string {
-  return JSON.stringify(
-    GlobalMarketsPerpsDepositRequest$outboundSchema.parse(
-      globalMarketsPerpsDepositRequest,
-    ),
-  );
-}

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

package/src/models/components/globalmarketsperpsdepositsponsorpreparerequest.ts

@@ -1,76 +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";
-
-/**
- * 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 GlobalMarketsPerpsDepositSponsorPrepareRequest = {
-  /**
-   * 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 GlobalMarketsPerpsDepositSponsorPrepareRequest$Outbound = {
-  owner: string;
-  amount_raw: number;
-  deadline: number;
-  signature: string;
-  sender: string;
-};
-
-/** @internal */
-export const GlobalMarketsPerpsDepositSponsorPrepareRequest$outboundSchema:
-  z.ZodType<
-    GlobalMarketsPerpsDepositSponsorPrepareRequest$Outbound,
-    z.ZodTypeDef,
-    GlobalMarketsPerpsDepositSponsorPrepareRequest
-  > = 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 globalMarketsPerpsDepositSponsorPrepareRequestToJSON(
-  globalMarketsPerpsDepositSponsorPrepareRequest:
-    GlobalMarketsPerpsDepositSponsorPrepareRequest,
-): string {
-  return JSON.stringify(
-    GlobalMarketsPerpsDepositSponsorPrepareRequest$outboundSchema.parse(
-      globalMarketsPerpsDepositSponsorPrepareRequest,
-    ),
-  );
-}

package/src/models/components/globalmarketsperpsdepositsponsorprepareresponse.ts

@@ -1,51 +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 {
-  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 GlobalMarketsPerpsDepositSponsorPrepareResponse = {
-  transaction: UnsignedTransaction;
-};
-
-/** @internal */
-export const GlobalMarketsPerpsDepositSponsorPrepareResponse$inboundSchema:
-  z.ZodType<
-    GlobalMarketsPerpsDepositSponsorPrepareResponse,
-    z.ZodTypeDef,
-    unknown
-  > = z.object({
-    transaction: UnsignedTransaction$inboundSchema,
-  });
-
-export function globalMarketsPerpsDepositSponsorPrepareResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<
-  GlobalMarketsPerpsDepositSponsorPrepareResponse,
-  SDKValidationError
-> {
-  return safeParse(
-    jsonString,
-    (x) =>
-      GlobalMarketsPerpsDepositSponsorPrepareResponse$inboundSchema.parse(
-        JSON.parse(x),
-      ),
-    `Failed to parse 'GlobalMarketsPerpsDepositSponsorPrepareResponse' from JSON`,
-  );
-}

package/src/models/components/globalmarketsperpsenableunifiedaccountrequest.ts

@@ -1,41 +0,0 @@
-/*
- * 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 GlobalMarketsPerpsEnableUnifiedAccountRequest = {
-  /**
-   * User's EOA address
-   */
-  owner: string;
-};
-
-/** @internal */
-export type GlobalMarketsPerpsEnableUnifiedAccountRequest$Outbound = {
-  owner: string;
-};
-
-/** @internal */
-export const GlobalMarketsPerpsEnableUnifiedAccountRequest$outboundSchema:
-  z.ZodType<
-    GlobalMarketsPerpsEnableUnifiedAccountRequest$Outbound,
-    z.ZodTypeDef,
-    GlobalMarketsPerpsEnableUnifiedAccountRequest
-  > = z.object({
-    owner: z.string(),
-  });
-
-export function globalMarketsPerpsEnableUnifiedAccountRequestToJSON(
-  globalMarketsPerpsEnableUnifiedAccountRequest:
-    GlobalMarketsPerpsEnableUnifiedAccountRequest,
-): string {
-  return JSON.stringify(
-    GlobalMarketsPerpsEnableUnifiedAccountRequest$outboundSchema.parse(
-      globalMarketsPerpsEnableUnifiedAccountRequest,
-    ),
-  );
-}

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

package/src/models/components/globalmarketsperpsensureleveragerequest.ts

@@ -1,46 +0,0 @@
-/*
- * 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 global markets perps asset.
- */
-export type GlobalMarketsPerpsEnsureLeverageRequest = {
-  /**
-   * User's EOA address
-   */
-  owner: string;
-  /**
-   * Asset ticker (e.g. 'AAPL', 'CL')
-   */
-  asset: string;
-};
-
-/** @internal */
-export type GlobalMarketsPerpsEnsureLeverageRequest$Outbound = {
-  owner: string;
-  asset: string;
-};
-
-/** @internal */
-export const GlobalMarketsPerpsEnsureLeverageRequest$outboundSchema: z.ZodType<
-  GlobalMarketsPerpsEnsureLeverageRequest$Outbound,
-  z.ZodTypeDef,
-  GlobalMarketsPerpsEnsureLeverageRequest
-> = z.object({
-  owner: z.string(),
-  asset: z.string(),
-});
-
-export function globalMarketsPerpsEnsureLeverageRequestToJSON(
-  globalMarketsPerpsEnsureLeverageRequest:
-    GlobalMarketsPerpsEnsureLeverageRequest,
-): string {
-  return JSON.stringify(
-    GlobalMarketsPerpsEnsureLeverageRequest$outboundSchema.parse(
-      globalMarketsPerpsEnsureLeverageRequest,
-    ),
-  );
-}