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

package/src/models/components/tradfiopportunity.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 TradFi perpetual futures market.
+ */
+export type TradFiOpportunity = {
+  /**
+   * 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 TradFiOpportunity$inboundSchema: z.ZodType<
+  TradFiOpportunity,
+  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 tradFiOpportunityFromJSON(
+  jsonString: string,
+): SafeParseResult<TradFiOpportunity, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TradFiOpportunity$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TradFiOpportunity' from JSON`,
+  );
+}

package/src/models/components/tradfiorderresponse.ts

@@ -0,0 +1,38 @@
+/*
+ * 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";
+
+/**
+ * Response containing an unsigned HyperEVM transaction for an order operation.
+ */
+export type TradFiOrderResponse = {
+  transaction: UnsignedTransaction;
+};
+
+/** @internal */
+export const TradFiOrderResponse$inboundSchema: z.ZodType<
+  TradFiOrderResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transaction: UnsignedTransaction$inboundSchema,
+});
+
+export function tradFiOrderResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TradFiOrderResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TradFiOrderResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TradFiOrderResponse' from JSON`,
+  );
+}

package/src/models/components/tradfiposition.ts

@@ -0,0 +1,116 @@
+/*
+ * 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 Side = {
+  Long: "long",
+  Short: "short",
+} as const;
+/**
+ * Position side: 'long' or 'short'
+ */
+export type Side = ClosedEnum<typeof Side>;
+
+/**
+ * A single open perpetual futures position.
+ */
+export type TradFiPosition = {
+  /**
+   * Asset ticker symbol
+   */
+  asset: string;
+  /**
+   * Hyperliquid asset index
+   */
+  assetId: number;
+  /**
+   * Position side: 'long' or 'short'
+   */
+  side: Side;
+  /**
+   * 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 Side$inboundSchema: z.ZodNativeEnum<typeof Side> = z.nativeEnum(
+  Side,
+);
+
+/** @internal */
+export const TradFiPosition$inboundSchema: z.ZodType<
+  TradFiPosition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  asset: z.string(),
+  asset_id: z.number().int(),
+  side: Side$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 tradFiPositionFromJSON(
+  jsonString: string,
+): SafeParseResult<TradFiPosition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TradFiPosition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TradFiPosition' from JSON`,
+  );
+}

package/src/models/components/tradfipositionsresponse.ts

@@ -0,0 +1,41 @@
+/*
+ * 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 {
+  TradFiPosition,
+  TradFiPosition$inboundSchema,
+} from "./tradfiposition.js";
+
+/**
+ * List of open TradFi perp positions.
+ */
+export type TradFiPositionsResponse = {
+  /**
+   * Open perpetual futures positions
+   */
+  positions: Array<TradFiPosition>;
+};
+
+/** @internal */
+export const TradFiPositionsResponse$inboundSchema: z.ZodType<
+  TradFiPositionsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  positions: z.array(TradFiPosition$inboundSchema),
+});
+
+export function tradFiPositionsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TradFiPositionsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TradFiPositionsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TradFiPositionsResponse' from JSON`,
+  );
+}

package/src/models/components/tradfiwithdrawrequest.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Request to withdraw USDC from HyperEVM TradFi account to Arbitrum.
+ */
+export type TradFiWithdrawRequest = {
+  /**
+   * The user's EOA address (owner of the TradFi 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 TradFiWithdrawRequest$Outbound = {
+  owner: string;
+  amount: string;
+  destination?: string | null | undefined;
+};
+
+/** @internal */
+export const TradFiWithdrawRequest$outboundSchema: z.ZodType<
+  TradFiWithdrawRequest$Outbound,
+  z.ZodTypeDef,
+  TradFiWithdrawRequest
+> = z.object({
+  owner: z.string(),
+  amount: z.string(),
+  destination: z.nullable(z.string()).optional(),
+});
+
+export function tradFiWithdrawRequestToJSON(
+  tradFiWithdrawRequest: TradFiWithdrawRequest,
+): string {
+  return JSON.stringify(
+    TradFiWithdrawRequest$outboundSchema.parse(tradFiWithdrawRequest),
+  );
+}

package/src/models/components/tradfiwithdrawresponse.ts

@@ -0,0 +1,41 @@
+/*
+ * 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";
+
+/**
+ * Response containing unsigned HyperEVM transactions for USDC withdrawal.
+ */
+export type TradFiWithdrawResponse = {
+  /**
+   * Unsigned HyperEVM transactions to withdraw USDC to Arbitrum
+   */
+  transactions: Array<UnsignedTransaction>;
+};
+
+/** @internal */
+export const TradFiWithdrawResponse$inboundSchema: z.ZodType<
+  TradFiWithdrawResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transactions: z.array(UnsignedTransaction$inboundSchema),
+});
+
+export function tradFiWithdrawResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TradFiWithdrawResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TradFiWithdrawResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TradFiWithdrawResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -49,3 +49,5 @@ export * from "./v2earnpendlemarkets.js";
 export * from "./v2earnpositions.js";
 export * from "./v2earnpositionsall.js";
 export * from "./v2earnvaults.js";
+export * from "./v2tradfiopportunities.js";
+export * from "./v2tradfipositions.js";

package/src/models/operations/v2tradfiopportunities.ts

@@ -0,0 +1,104 @@
+/*
+ * 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";
+import * as components from "../components/index.js";
+
+/**
+ * Sort results by this field
+ */
+export const TradFiSortBy = {
+  OpenInterest: "open_interest",
+  Volume24h: "volume_24h",
+  FundingRate: "funding_rate",
+} as const;
+/**
+ * Sort results by this field
+ */
+export type TradFiSortBy = ClosedEnum<typeof TradFiSortBy>;
+
+/**
+ * Sort direction
+ */
+export const TradFiSortOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+/**
+ * Sort direction
+ */
+export type TradFiSortOrder = ClosedEnum<typeof TradFiSortOrder>;
+
+export type V2TradfiOpportunitiesRequest = {
+  /**
+   * Filter by minimum open interest in USD
+   */
+  minOpenInterest?: number | null | undefined;
+  /**
+   * Filter by minimum 24h volume in USD
+   */
+  minVolume24h?: number | null | undefined;
+  /**
+   * Filter by asset category: stock, commodity, forex
+   */
+  category?: components.TradFiCategory | null | undefined;
+  /**
+   * Sort results by this field
+   */
+  sortBy?: TradFiSortBy | undefined;
+  /**
+   * Sort direction
+   */
+  sortOrder?: TradFiSortOrder | undefined;
+};
+
+/** @internal */
+export const TradFiSortBy$outboundSchema: z.ZodNativeEnum<typeof TradFiSortBy> =
+  z.nativeEnum(TradFiSortBy);
+
+/** @internal */
+export const TradFiSortOrder$outboundSchema: z.ZodNativeEnum<
+  typeof TradFiSortOrder
+> = z.nativeEnum(TradFiSortOrder);
+
+/** @internal */
+export type V2TradfiOpportunitiesRequest$Outbound = {
+  min_open_interest?: number | null | undefined;
+  min_volume_24h?: number | null | undefined;
+  category?: string | null | undefined;
+  sort_by?: string | undefined;
+  sort_order?: string | undefined;
+};
+
+/** @internal */
+export const V2TradfiOpportunitiesRequest$outboundSchema: z.ZodType<
+  V2TradfiOpportunitiesRequest$Outbound,
+  z.ZodTypeDef,
+  V2TradfiOpportunitiesRequest
+> = z.object({
+  minOpenInterest: z.nullable(z.number()).optional(),
+  minVolume24h: z.nullable(z.number()).optional(),
+  category: z.nullable(components.TradFiCategory$outboundSchema).optional(),
+  sortBy: TradFiSortBy$outboundSchema.optional(),
+  sortOrder: TradFiSortOrder$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    minOpenInterest: "min_open_interest",
+    minVolume24h: "min_volume_24h",
+    sortBy: "sort_by",
+    sortOrder: "sort_order",
+  });
+});
+
+export function v2TradfiOpportunitiesRequestToJSON(
+  v2TradfiOpportunitiesRequest: V2TradfiOpportunitiesRequest,
+): string {
+  return JSON.stringify(
+    V2TradfiOpportunitiesRequest$outboundSchema.parse(
+      v2TradfiOpportunitiesRequest,
+    ),
+  );
+}

package/src/models/operations/v2tradfipositions.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type V2TradfiPositionsRequest = {
+  /**
+   * User's EOA address (looks up their TradFi product account)
+   */
+  owner: string;
+  /**
+   * Filter to a specific asset ticker (e.g. AAPL)
+   */
+  asset?: string | null | undefined;
+};
+
+/** @internal */
+export type V2TradfiPositionsRequest$Outbound = {
+  owner: string;
+  asset?: string | null | undefined;
+};
+
+/** @internal */
+export const V2TradfiPositionsRequest$outboundSchema: z.ZodType<
+  V2TradfiPositionsRequest$Outbound,
+  z.ZodTypeDef,
+  V2TradfiPositionsRequest
+> = z.object({
+  owner: z.string(),
+  asset: z.nullable(z.string()).optional(),
+});
+
+export function v2TradfiPositionsRequestToJSON(
+  v2TradfiPositionsRequest: V2TradfiPositionsRequest,
+): string {
+  return JSON.stringify(
+    V2TradfiPositionsRequest$outboundSchema.parse(v2TradfiPositionsRequest),
+  );
+}

package/src/sdk/sdk.ts

@@ -17,6 +17,7 @@ import { Sky } from "./sky.js";
 import { SmartAccount } from "./smartaccount.js";
 import { Swap } from "./swap.js";
 import { Token } from "./token.js";
+import { TradFi } from "./tradfi.js";
 import { TransactionBundler } from "./transactionbundler.js";
 import { UniswapV3 } from "./uniswapv3.js";
 import { Universal } from "./universal.js";
@@ -114,4 +115,9 @@ export class CompassApiSDK extends ClientSDK {
   get credit(): Credit {
     return (this._credit ??= new Credit(this._options));
   }
+
+  private _tradFi?: TradFi;
+  get tradFi(): TradFi {
+    return (this._tradFi ??= new TradFi(this._options));
+  }
 }