@compass-labs/api-sdk 2.2.33 → 2.2.34-rc.1

package/src/sdk/tradfi.ts

@@ -0,0 +1,198 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { tradFiTradfiCancelOrder } from "../funcs/tradFiTradfiCancelOrder.js";
+import { tradFiTradfiCreateAccount } from "../funcs/tradFiTradfiCreateAccount.js";
+import { tradFiTradfiDeposit } from "../funcs/tradFiTradfiDeposit.js";
+import { tradFiTradfiLimitOrder } from "../funcs/tradFiTradfiLimitOrder.js";
+import { tradFiTradfiMarketOrder } from "../funcs/tradFiTradfiMarketOrder.js";
+import { tradFiTradfiOpportunities } from "../funcs/tradFiTradfiOpportunities.js";
+import { tradFiTradfiPositions } from "../funcs/tradFiTradfiPositions.js";
+import { tradFiTradfiWithdraw } from "../funcs/tradFiTradfiWithdraw.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 TradFi extends ClientSDK {
+  /**
+   * List TradFi perp markets
+   *
+   * @remarks
+   * List available TradFi perpetual futures markets with key metrics.
+   *
+   * Returns tradfi 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 tradfi assets are returned — crypto perps are excluded.
+   */
+  async tradfiOpportunities(
+    request: operations.V2TradfiOpportunitiesRequest,
+    options?: RequestOptions,
+  ): Promise<components.TradFiOpportunitiesResponse> {
+    return unwrapAsync(tradFiTradfiOpportunities(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List TradFi positions
+   *
+   * @remarks
+   * List open perpetual futures positions for a user's TradFi account.
+   *
+   * Returns position data including size, entry price, mark price, PnL, liquidation price,
+   * leverage, and cumulative funding. Optionally filter by asset ticker.
+   *
+   * Returns 404 if the user has no TradFi product account.
+   * Returns an empty list if no positions are open.
+   */
+  async tradfiPositions(
+    request: operations.V2TradfiPositionsRequest,
+    options?: RequestOptions,
+  ): Promise<components.TradFiPositionsResponse> {
+    return unwrapAsync(tradFiTradfiPositions(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create TradFi account
+   *
+   * @remarks
+   * Create a TradFi product account on HyperEVM.
+   *
+   * Before trading perpetual futures or depositing USDC, the owner must create a TradFi
+   * product account. Each wallet address has one TradFi account.
+   *
+   * Returns an unsigned transaction to create the account. The `sender` signs and broadcasts
+   * this transaction on HyperEVM (gas paid in HYPE).
+   */
+  async tradfiCreateAccount(
+    request: components.CreateTradFiAccountRequest,
+    options?: RequestOptions,
+  ): Promise<components.CreateTradFiAccountResponse> {
+    return unwrapAsync(tradFiTradfiCreateAccount(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Deposit USDC to TradFi account
+   *
+   * @remarks
+   * Bridge USDC from Arbitrum to the TradFi account on HyperEVM.
+   *
+   * Returns unsigned Arbitrum transactions: USDC approval (if current allowance is insufficient)
+   * followed by a bridge deposit to the Hyperliquid Arbitrum bridge contract.
+   *
+   * After the bridge deposit confirms, USDC lands on HyperCore and can be used for trading.
+   */
+  async tradfiDeposit(
+    request: components.TradFiDepositRequest,
+    options?: RequestOptions,
+  ): Promise<components.TradFiDepositResponse> {
+    return unwrapAsync(tradFiTradfiDeposit(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Withdraw USDC from TradFi account
+   *
+   * @remarks
+   * Withdraw USDC from HyperEVM Safe back to Arbitrum.
+   *
+   * Returns unsigned HyperEVM transactions to transfer USDC from the Safe to HyperCore,
+   * then initiate a withdrawal to the destination address on Arbitrum.
+   *
+   * Withdrawal processing takes minutes to hours depending on bridge conditions.
+   */
+  async tradfiWithdraw(
+    request: components.TradFiWithdrawRequest,
+    options?: RequestOptions,
+  ): Promise<components.TradFiWithdrawResponse> {
+    return unwrapAsync(tradFiTradfiWithdraw(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Place market order
+   *
+   * @remarks
+   * Place a market order on a TradFi perpetual futures market.
+   *
+   * Executes as an IOC (Immediate or Cancel) order at the current mark price with
+   * slippage protection. The transaction is a Safe execTransaction wrapping a
+   * CoreWriter call on HyperEVM.
+   *
+   * Orders are asynchronous — execution confirms a few seconds after the transaction,
+   * not atomically.
+   */
+  async tradfiMarketOrder(
+    request: components.TradFiMarketOrderRequest,
+    options?: RequestOptions,
+  ): Promise<components.TradFiOrderResponse> {
+    return unwrapAsync(tradFiTradfiMarketOrder(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Place limit order
+   *
+   * @remarks
+   * Place a limit order on a TradFi perpetual futures market.
+   *
+   * Supports GTC (Good Til Cancel) and ALO (Add Liquidity Only) time-in-force types.
+   * The transaction is a Safe execTransaction wrapping a CoreWriter call on HyperEVM.
+   *
+   * Orders are asynchronous — execution confirms a few seconds after the transaction,
+   * not atomically.
+   */
+  async tradfiLimitOrder(
+    request: components.TradFiLimitOrderRequest,
+    options?: RequestOptions,
+  ): Promise<components.TradFiOrderResponse> {
+    return unwrapAsync(tradFiTradfiLimitOrder(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Cancel order
+   *
+   * @remarks
+   * Cancel an open order on a TradFi perpetual futures market.
+   *
+   * Cancel by either Hyperliquid order ID or client order ID. The transaction is a
+   * Safe execTransaction wrapping a CoreWriter call on HyperEVM.
+   */
+  async tradfiCancelOrder(
+    request: components.TradFiCancelOrderRequest,
+    options?: RequestOptions,
+  ): Promise<components.TradFiOrderResponse> {
+    return unwrapAsync(tradFiTradfiCancelOrder(
+      this,
+      request,
+      options,
+    ));
+  }
+}