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

package/src/funcs/tradFiTradfiWithdraw.ts

@@ -0,0 +1,174 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { CompassAPISDKError } from "../models/errors/compassapisdkerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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.
+ */
+export function tradFiTradfiWithdraw(
+  client: CompassApiSDKCore,
+  request: components.TradFiWithdrawRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.TradFiWithdrawResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.TradFiWithdrawRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.TradFiWithdrawResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.TradFiWithdrawRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v2/tradfi/withdraw")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "v2_tradfi_withdraw",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.TradFiWithdrawResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.TradFiWithdrawResponse$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/models/components/chain.ts

@@ -12,6 +12,7 @@ export const Chain = {
   Base: "base",
   Ethereum: "ethereum",
   Arbitrum: "arbitrum",
+  Hyperevm: "hyperevm",
 } as const;
 /**
  * The chain to use.

package/src/models/components/createtradfiaccountrequest.ts

@@ -0,0 +1,70 @@
+/*
+ * 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";
+
+export const CreateTradFiAccountRequestChain = {
+  Hyperevm: "hyperevm",
+} as const;
+export type CreateTradFiAccountRequestChain = ClosedEnum<
+  typeof CreateTradFiAccountRequestChain
+>;
+
+/**
+ * Request to create a TradFi product account on HyperEVM.
+ */
+export type CreateTradFiAccountRequest = {
+  chain: CreateTradFiAccountRequestChain;
+  /**
+   * The address of the transaction sender.
+   */
+  sender: string;
+  /**
+   * Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.
+   */
+  estimateGas?: boolean | undefined;
+  /**
+   * The address that will own and control the product account
+   */
+  owner: string;
+};
+
+/** @internal */
+export const CreateTradFiAccountRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof CreateTradFiAccountRequestChain
+> = z.nativeEnum(CreateTradFiAccountRequestChain);
+
+/** @internal */
+export type CreateTradFiAccountRequest$Outbound = {
+  chain: string;
+  sender: string;
+  estimate_gas?: boolean | undefined;
+  owner: string;
+};
+
+/** @internal */
+export const CreateTradFiAccountRequest$outboundSchema: z.ZodType<
+  CreateTradFiAccountRequest$Outbound,
+  z.ZodTypeDef,
+  CreateTradFiAccountRequest
+> = z.object({
+  chain: CreateTradFiAccountRequestChain$outboundSchema,
+  sender: z.string(),
+  estimateGas: z.boolean().optional(),
+  owner: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    estimateGas: "estimate_gas",
+  });
+});
+
+export function createTradFiAccountRequestToJSON(
+  createTradFiAccountRequest: CreateTradFiAccountRequest,
+): string {
+  return JSON.stringify(
+    CreateTradFiAccountRequest$outboundSchema.parse(createTradFiAccountRequest),
+  );
+}

package/src/models/components/createtradfiaccountresponse.ts

@@ -0,0 +1,51 @@
+/*
+ * 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 {
+  UnsignedTransaction,
+  UnsignedTransaction$inboundSchema,
+} from "./unsignedtransaction.js";
+
+/**
+ * Response containing unsigned transaction to create a TradFi product account.
+ */
+export type CreateTradFiAccountResponse = {
+  /**
+   * Transaction to create the product account (None if already deployed)
+   */
+  transaction: UnsignedTransaction | null;
+  /**
+   * Predicted address of the product account that will be deployed on HyperEVM
+   */
+  tradfiAccountAddress: string;
+};
+
+/** @internal */
+export const CreateTradFiAccountResponse$inboundSchema: z.ZodType<
+  CreateTradFiAccountResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transaction: z.nullable(UnsignedTransaction$inboundSchema),
+  tradfi_account_address: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "tradfi_account_address": "tradfiAccountAddress",
+  });
+});
+
+export function createTradFiAccountResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateTradFiAccountResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateTradFiAccountResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateTradFiAccountResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -85,6 +85,8 @@ export * from "./createaccountrequest.js";
 export * from "./createaccountresponse.js";
 export * from "./createcreditaccountrequest.js";
 export * from "./createcreditaccountresponse.js";
+export * from "./createtradfiaccountrequest.js";
+export * from "./createtradfiaccountresponse.js";
 export * from "./creditbalancesresponse.js";
 export * from "./creditborrowparams.js";
 export * from "./creditborrowrequest.js";
@@ -242,6 +244,19 @@ export * from "./tokenpriceresponse.js";
 export * from "./tokentransfer.js";
 export * from "./tokentransferparams.js";
 export * from "./tokentransferrequest.js";
+export * from "./tradficancelorderrequest.js";
+export * from "./tradficategory.js";
+export * from "./tradfidepositrequest.js";
+export * from "./tradfidepositresponse.js";
+export * from "./tradfilimitorderrequest.js";
+export * from "./tradfimarketorderrequest.js";
+export * from "./tradfiopportunitiesresponse.js";
+export * from "./tradfiopportunity.js";
+export * from "./tradfiorderresponse.js";
+export * from "./tradfiposition.js";
+export * from "./tradfipositionsresponse.js";
+export * from "./tradfiwithdrawrequest.js";
+export * from "./tradfiwithdrawresponse.js";
 export * from "./transactionresponse.js";
 export * from "./underlyingtoken.js";
 export * from "./uniswapbuyexactlyparams.js";

package/src/models/components/tradficancelorderrequest.ts

@@ -0,0 +1,61 @@
+/*
+ * 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 TradFi perp market.
+ */
+export type TradFiCancelOrderRequest = {
+  /**
+   * Owner of the TradFi 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 TradFiCancelOrderRequest$Outbound = {
+  owner: string;
+  asset: string;
+  order_id?: number | null | undefined;
+  client_order_id?: number | null | undefined;
+};
+
+/** @internal */
+export const TradFiCancelOrderRequest$outboundSchema: z.ZodType<
+  TradFiCancelOrderRequest$Outbound,
+  z.ZodTypeDef,
+  TradFiCancelOrderRequest
+> = 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 tradFiCancelOrderRequestToJSON(
+  tradFiCancelOrderRequest: TradFiCancelOrderRequest,
+): string {
+  return JSON.stringify(
+    TradFiCancelOrderRequest$outboundSchema.parse(tradFiCancelOrderRequest),
+  );
+}

package/src/models/components/tradficategory.ts

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

package/src/models/components/tradfidepositrequest.ts

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

package/src/models/components/tradfidepositresponse.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 Arbitrum transactions for USDC deposit.
+ */
+export type TradFiDepositResponse = {
+  /**
+   * Unsigned Arbitrum transactions: USDC approval (if needed) + bridge deposit
+   */
+  transactions: Array<UnsignedTransaction>;
+};
+
+/** @internal */
+export const TradFiDepositResponse$inboundSchema: z.ZodType<
+  TradFiDepositResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transactions: z.array(UnsignedTransaction$inboundSchema),
+});
+
+export function tradFiDepositResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TradFiDepositResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TradFiDepositResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TradFiDepositResponse' from JSON`,
+  );
+}

package/src/models/components/tradfilimitorderrequest.ts

@@ -0,0 +1,86 @@
+/*
+ * 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 place a limit order on a TradFi perp market.
+ */
+export type TradFiLimitOrderRequest = {
+  /**
+   * Owner of the TradFi product account
+   */
+  owner: string;
+  /**
+   * Asset ticker symbol (e.g. AAPL, GOLD, EUR)
+   */
+  asset: string;
+  /**
+   * Order side: 'buy' or 'sell'
+   */
+  side: string;
+  /**
+   * Number of contracts (human-readable)
+   */
+  size: string;
+  /**
+   * Limit price (human-readable)
+   */
+  price: string;
+  /**
+   * Time-in-force: 'gtc' (good til cancel) or 'alo' (add liquidity only)
+   */
+  timeInForce?: string | undefined;
+  /**
+   * If true, order can only reduce an existing position
+   */
+  reduceOnly?: boolean | undefined;
+  /**
+   * Optional client order ID for idempotency (uint128)
+   */
+  clientOrderId?: number | null | undefined;
+};
+
+/** @internal */
+export type TradFiLimitOrderRequest$Outbound = {
+  owner: string;
+  asset: string;
+  side: string;
+  size: string;
+  price: string;
+  time_in_force?: string | undefined;
+  reduce_only?: boolean | undefined;
+  client_order_id?: number | null | undefined;
+};
+
+/** @internal */
+export const TradFiLimitOrderRequest$outboundSchema: z.ZodType<
+  TradFiLimitOrderRequest$Outbound,
+  z.ZodTypeDef,
+  TradFiLimitOrderRequest
+> = z.object({
+  owner: z.string(),
+  asset: z.string(),
+  side: z.string(),
+  size: z.string(),
+  price: z.string(),
+  timeInForce: z.string().optional(),
+  reduceOnly: z.boolean().optional(),
+  clientOrderId: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    timeInForce: "time_in_force",
+    reduceOnly: "reduce_only",
+    clientOrderId: "client_order_id",
+  });
+});
+
+export function tradFiLimitOrderRequestToJSON(
+  tradFiLimitOrderRequest: TradFiLimitOrderRequest,
+): string {
+  return JSON.stringify(
+    TradFiLimitOrderRequest$outboundSchema.parse(tradFiLimitOrderRequest),
+  );
+}

package/src/models/components/tradfimarketorderrequest.ts

@@ -0,0 +1,73 @@
+/*
+ * 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 place a market order on a TradFi perp market.
+ */
+export type TradFiMarketOrderRequest = {
+  /**
+   * Owner of the TradFi product account
+   */
+  owner: string;
+  /**
+   * Asset ticker symbol (e.g. AAPL, GOLD, EUR)
+   */
+  asset: string;
+  /**
+   * Order side: 'buy' or 'sell'
+   */
+  side: string;
+  /**
+   * Number of contracts (human-readable)
+   */
+  size: string;
+  /**
+   * Max slippage percentage for price protection
+   */
+  slippagePercent?: number | undefined;
+  /**
+   * If true, order can only reduce an existing position
+   */
+  reduceOnly?: boolean | undefined;
+};
+
+/** @internal */
+export type TradFiMarketOrderRequest$Outbound = {
+  owner: string;
+  asset: string;
+  side: string;
+  size: string;
+  slippage_percent?: number | undefined;
+  reduce_only?: boolean | undefined;
+};
+
+/** @internal */
+export const TradFiMarketOrderRequest$outboundSchema: z.ZodType<
+  TradFiMarketOrderRequest$Outbound,
+  z.ZodTypeDef,
+  TradFiMarketOrderRequest
+> = z.object({
+  owner: z.string(),
+  asset: z.string(),
+  side: z.string(),
+  size: z.string(),
+  slippagePercent: z.number().optional(),
+  reduceOnly: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    slippagePercent: "slippage_percent",
+    reduceOnly: "reduce_only",
+  });
+});
+
+export function tradFiMarketOrderRequestToJSON(
+  tradFiMarketOrderRequest: TradFiMarketOrderRequest,
+): string {
+  return JSON.stringify(
+    TradFiMarketOrderRequest$outboundSchema.parse(tradFiMarketOrderRequest),
+  );
+}

package/src/models/components/tradfiopportunitiesresponse.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 {
+  TradFiOpportunity,
+  TradFiOpportunity$inboundSchema,
+} from "./tradfiopportunity.js";
+
+/**
+ * List of available TradFi perpetual futures markets.
+ */
+export type TradFiOpportunitiesResponse = {
+  /**
+   * Available tradfi perp markets
+   */
+  opportunities: Array<TradFiOpportunity>;
+};
+
+/** @internal */
+export const TradFiOpportunitiesResponse$inboundSchema: z.ZodType<
+  TradFiOpportunitiesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  opportunities: z.array(TradFiOpportunity$inboundSchema),
+});
+
+export function tradFiOpportunitiesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TradFiOpportunitiesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TradFiOpportunitiesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TradFiOpportunitiesResponse' from JSON`,
+  );
+}