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

package/src/sdk/globalmarketsperps.ts

@@ -1,359 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { globalMarketsPerpsGlobalMarketsPerpsActivity } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsActivity.js";
-import { globalMarketsPerpsGlobalMarketsPerpsApproveBuilderFee } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsApproveBuilderFee.js";
-import { globalMarketsPerpsGlobalMarketsPerpsCancelOrder } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsCancelOrder.js";
-import { globalMarketsPerpsGlobalMarketsPerpsCandles } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsCandles.js";
-import { globalMarketsPerpsGlobalMarketsPerpsDeposit } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsDeposit.js";
-import { globalMarketsPerpsGlobalMarketsPerpsDepositSponsorPrepare } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsDepositSponsorPrepare.js";
-import { globalMarketsPerpsGlobalMarketsPerpsEnableUnifiedAccount } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsEnableUnifiedAccount.js";
-import { globalMarketsPerpsGlobalMarketsPerpsEnsureLeverage } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsEnsureLeverage.js";
-import { globalMarketsPerpsGlobalMarketsPerpsExecute } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsExecute.js";
-import { globalMarketsPerpsGlobalMarketsPerpsLimitOrder } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsLimitOrder.js";
-import { globalMarketsPerpsGlobalMarketsPerpsMarketOrder } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsMarketOrder.js";
-import { globalMarketsPerpsGlobalMarketsPerpsOpportunities } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsOpportunities.js";
-import { globalMarketsPerpsGlobalMarketsPerpsPositions } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsPositions.js";
-import { globalMarketsPerpsGlobalMarketsPerpsSetLeverage } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsSetLeverage.js";
-import { globalMarketsPerpsGlobalMarketsPerpsWithdraw } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsWithdraw.js";
-import { ClientSDK, RequestOptions } from "../lib/sdks.js";
-import * as components from "../models/components/index.js";
-import * as operations from "../models/operations/index.js";
-import { unwrapAsync } from "../types/fp.js";
-
-export class GlobalMarketsPerps extends ClientSDK {
-  /**
-   * List global markets perps markets
-   *
-   * @remarks
-   * List available global markets perps markets with key metrics.
-   *
-   * Returns perp markets (stocks, commodities, forex) with open interest,
-   * 24h volume, funding rate, and max leverage. Supports filtering by category,
-   * minimum OI/volume, and sorting.
-   *
-   * Only global markets perps assets are returned — crypto perps are excluded.
-   */
-  async globalMarketsPerpsOpportunities(
-    request: operations.V2GlobalMarketsPerpsOpportunitiesRequest,
-    options?: RequestOptions,
-  ): Promise<components.GlobalMarketsPerpsOpportunitiesResponse> {
-    return unwrapAsync(globalMarketsPerpsGlobalMarketsPerpsOpportunities(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * List global markets perps positions
-   *
-   * @remarks
-   * List open perpetual futures positions for a user.
-   *
-   * Returns position data including size, entry price, mark price, PnL, liquidation price,
-   * leverage, and cumulative funding. Optionally filter by asset ticker.
-   * Returns an empty list if no positions are open.
-   */
-  async globalMarketsPerpsPositions(
-    request: operations.V2GlobalMarketsPerpsPositionsRequest,
-    options?: RequestOptions,
-  ): Promise<components.GlobalMarketsPerpsPositionsResponse> {
-    return unwrapAsync(globalMarketsPerpsGlobalMarketsPerpsPositions(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Get OHLCV candles
-   *
-   * @remarks
-   * Return OHLCV candles for a single asset and interval.
-   *
-   * Wraps Hyperliquid's ``candleSnapshot`` info type and adds the xyz: HIP-3 DEX
-   * prefix server-side so the SDK only needs the bare ticker (e.g. ``AAPL``).
-   * Candle ``time`` is returned in unix seconds, ready for TradingView
-   * lightweight-charts. Cached for 15 seconds per (symbol, interval, window).
-   */
-  async globalMarketsPerpsCandles(
-    request: operations.V2GlobalMarketsPerpsCandlesRequest,
-    options?: RequestOptions,
-  ): Promise<components.GlobalMarketsPerpsCandlesResponse> {
-    return unwrapAsync(globalMarketsPerpsGlobalMarketsPerpsCandles(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Aggregated Hyperliquid activity for a user
-   *
-   * @remarks
-   * Return positions, fills, open orders, and (optionally) builder approval
-   * state for an end-user in one normalized payload.
-   *
-   * Each section is fetched in parallel from the Hyperliquid `info` API.
-   * If a single upstream call fails the corresponding section returns ``null``
-   * and an entry is added to ``partial_errors``; if every section fails the
-   * endpoint responds with 502.
-   *
-   * Pass ``builder`` to additionally include the user's current approved max
-   * fee rate for that builder (used by dashboards to decide whether to prompt
-   * the user to sign an `approveBuilderFee` action).
-   */
-  async globalMarketsPerpsActivity(
-    request: operations.V2GlobalMarketsPerpsActivityRequest,
-    options?: RequestOptions,
-  ): Promise<components.GlobalMarketsPerpsActivityResponse> {
-    return unwrapAsync(globalMarketsPerpsGlobalMarketsPerpsActivity(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Deposit USDC to global markets perps account
-   *
-   * @remarks
-   * Prepare a USDC deposit from Arbitrum via EIP-2612 Permit.
-   *
-   * Returns EIP-712 typed data for the user to sign off-chain (no gas needed).
-   * Compass does NOT broadcast the bridge tx — the integrator's own sponsor
-   * wallet calls batchedDepositWithPermit on the HL Bridge2 contract on
-   * Arbitrum after the user signs. See api_docs/v2/Products/Global-Markets.mdx
-   * "Deposit USDC" section for the bridge-broadcast code.
-   */
-  async globalMarketsPerpsDeposit(
-    request: components.GlobalMarketsPerpsDepositRequest,
-    options?: RequestOptions,
-  ): Promise<components.GlobalMarketsPerpsDepositResponse> {
-    return unwrapAsync(globalMarketsPerpsGlobalMarketsPerpsDeposit(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Build the Bridge2 deposit tx from a signed permit
-   *
-   * @remarks
-   * Build the Arbitrum tx that completes a USDC deposit to HL.
-   *
-   * Takes the EIP-2612 permit signature returned by /deposit and returns
-   * a fully-encoded `Bridge2.batchedDepositWithPermit` call. The integrator's
-   * sponsor wallet (`sender`) broadcasts the returned tx — Compass does not
-   * broadcast and does not hold gas keys.
-   */
-  async globalMarketsPerpsDepositSponsorPrepare(
-    request: components.GlobalMarketsPerpsDepositSponsorPrepareRequest,
-    options?: RequestOptions,
-  ): Promise<components.GlobalMarketsPerpsDepositSponsorPrepareResponse> {
-    return unwrapAsync(
-      globalMarketsPerpsGlobalMarketsPerpsDepositSponsorPrepare(
-        this,
-        request,
-        options,
-      ),
-    );
-  }
-
-  /**
-   * Withdraw USDC from global markets perps account
-   *
-   * @remarks
-   * Prepare a USDC withdrawal from Hyperliquid to Arbitrum.
-   *
-   * Returns EIP-712 typed data for the user to sign. After signing, submit
-   * the signature via the /execute endpoint. Withdrawal processing takes
-   * minutes to hours depending on bridge conditions.
-   */
-  async globalMarketsPerpsWithdraw(
-    request: components.GlobalMarketsPerpsWithdrawRequest,
-    options?: RequestOptions,
-  ): Promise<components.GlobalMarketsPerpsSignableActionResponse> {
-    return unwrapAsync(globalMarketsPerpsGlobalMarketsPerpsWithdraw(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Place market order
-   *
-   * @remarks
-   * Prepare a market order on a global markets perps market.
-   *
-   * Returns EIP-712 typed data for the user to sign. After signing, submit
-   * the signature via the /execute endpoint. Executes as an IOC order at the
-   * current mark price with slippage protection.
-   */
-  async globalMarketsPerpsMarketOrder(
-    request: components.GlobalMarketsPerpsMarketOrderRequest,
-    options?: RequestOptions,
-  ): Promise<components.GlobalMarketsPerpsSignableActionResponse> {
-    return unwrapAsync(globalMarketsPerpsGlobalMarketsPerpsMarketOrder(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Place limit order
-   *
-   * @remarks
-   * Prepare a limit order on a global markets perps market.
-   *
-   * Returns EIP-712 typed data for the user to sign. After signing, submit
-   * the signature via the /execute endpoint. Supports GTC and ALO time-in-force.
-   */
-  async globalMarketsPerpsLimitOrder(
-    request: components.GlobalMarketsPerpsLimitOrderRequest,
-    options?: RequestOptions,
-  ): Promise<components.GlobalMarketsPerpsSignableActionResponse> {
-    return unwrapAsync(globalMarketsPerpsGlobalMarketsPerpsLimitOrder(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Cancel order
-   *
-   * @remarks
-   * Prepare an order cancellation.
-   *
-   * Returns EIP-712 typed data for the user to sign. After signing, submit
-   * the signature via the /execute endpoint.
-   */
-  async globalMarketsPerpsCancelOrder(
-    request: components.GlobalMarketsPerpsCancelOrderRequest,
-    options?: RequestOptions,
-  ): Promise<components.GlobalMarketsPerpsSignableActionResponse> {
-    return unwrapAsync(globalMarketsPerpsGlobalMarketsPerpsCancelOrder(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Execute signed action
-   *
-   * @remarks
-   * Submit a signed Hyperliquid action for execution.
-   *
-   * Accepts the signature from any prepare endpoint (market_order, limit_order,
-   * cancel_order, withdraw, approve_builder_fee) and POSTs it to the Hyperliquid
-   * exchange API.
-   *
-   * The caller must have already hit a prepare endpoint, so no compass_account
-   * registration is performed here.
-   */
-  async globalMarketsPerpsExecute(
-    request: components.GlobalMarketsPerpsExecuteRequest,
-    options?: RequestOptions,
-  ): Promise<components.GlobalMarketsPerpsExecuteResponse> {
-    return unwrapAsync(globalMarketsPerpsGlobalMarketsPerpsExecute(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Approve builder fee
-   *
-   * @remarks
-   * Prepare builder fee approval for the global markets perps DEX.
-   *
-   * This is a one-time action required before placing the first trade.
-   * Returns EIP-712 typed data for the user to sign. After signing, submit
-   * the signature via the /execute endpoint.
-   */
-  async globalMarketsPerpsApproveBuilderFee(
-    request: components.GlobalMarketsPerpsApproveBuilderFeeRequest,
-    options?: RequestOptions,
-  ): Promise<components.GlobalMarketsPerpsSignableActionResponse> {
-    return unwrapAsync(globalMarketsPerpsGlobalMarketsPerpsApproveBuilderFee(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Enable unified account mode
-   *
-   * @remarks
-   * Check account mode and prepare the enable-unified-account action if needed.
-   *
-   * If the account is already in unified mode (or portfolio margin), returns
-   * the current mode with null typed_data — no signing needed. Otherwise,
-   * returns EIP-712 typed data for the user to sign. After signing, submit
-   * the signature via the /execute endpoint.
-   */
-  async globalMarketsPerpsEnableUnifiedAccount(
-    request: components.GlobalMarketsPerpsEnableUnifiedAccountRequest,
-    options?: RequestOptions,
-  ): Promise<components.GlobalMarketsPerpsEnableUnifiedAccountResponse> {
-    return unwrapAsync(globalMarketsPerpsGlobalMarketsPerpsEnableUnifiedAccount(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Ensure 1x cross leverage
-   *
-   * @remarks
-   * Check leverage and prepare an updateLeverage action if not 1x cross.
-   *
-   * If the asset is already at 1x cross leverage, returns leverage_ok=true
-   * with null typed_data — no signing needed. Otherwise, returns EIP-712
-   * typed data for the user to sign. After signing, submit the signature
-   * via the /execute endpoint.
-   */
-  async globalMarketsPerpsEnsureLeverage(
-    request: components.GlobalMarketsPerpsEnsureLeverageRequest,
-    options?: RequestOptions,
-  ): Promise<components.GlobalMarketsPerpsEnsureLeverageResponse> {
-    return unwrapAsync(globalMarketsPerpsGlobalMarketsPerpsEnsureLeverage(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Set leverage (defaults to market maximum)
-   *
-   * @remarks
-   * Check leverage and prepare an updateLeverage action to the requested value.
-   *
-   * If `leverage` is omitted, targets the asset's maximum leverage for that
-   * market. If the asset is already at the requested leverage, returns
-   * leverage_ok=true with null typed_data — no signing needed. Otherwise,
-   * returns EIP-712 typed data for the user to sign. After signing, submit the
-   * signature via the /execute endpoint.
-   */
-  async globalMarketsPerpsSetLeverage(
-    request: components.GlobalMarketsPerpsSetLeverageRequest,
-    options?: RequestOptions,
-  ): Promise<components.GlobalMarketsPerpsSetLeverageResponse> {
-    return unwrapAsync(globalMarketsPerpsGlobalMarketsPerpsSetLeverage(
-      this,
-      request,
-      options,
-    ));
-  }
-}