@compass-labs/api-sdk 2.2.34-rc.2 → 2.2.34-rc.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "2.2.34-rc.2",
+  "version": "2.2.34-rc.4",
   "author": "royalnine",
   "type": "module",
   "tshy": {

package/src/funcs/traditionalInvestingTraditionalInvestingApproveBuilderFee.ts

@@ -0,0 +1,178 @@
+/*
+ * 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";
+
+/**
+ * Approve builder fee
+ *
+ * @remarks
+ * Prepare builder fee approval for the traditional investments 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.
+ */
+export function traditionalInvestingTraditionalInvestingApproveBuilderFee(
+  client: CompassApiSDKCore,
+  request: components.TraditionalInvestingApproveBuilderFeeRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.TraditionalInvestingSignableActionResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.TraditionalInvestingApproveBuilderFeeRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.TraditionalInvestingSignableActionResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.TraditionalInvestingApproveBuilderFeeRequest$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/traditional_investing/approve_builder_fee")();
+
+  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_traditional_investing_approve_builder_fee",
+    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.TraditionalInvestingSignableActionResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      components.TraditionalInvestingSignableActionResponse$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/funcs/{tradFiTradfiCancelOrder.ts → traditionalInvestingTraditionalInvestingCancelOrder.ts}

@@ -29,18 +29,18 @@ import { Result } from "../types/fp.js";
  * Cancel order
  *
  * @remarks
- * Cancel an open order on a TradFi perpetual futures market.
+ * Prepare an order cancellation.
  *
- * Cancel by either Hyperliquid order ID or client order ID. The transaction is a
- * Safe execTransaction wrapping a CoreWriter call on HyperEVM.
+ * Returns EIP-712 typed data for the user to sign. After signing, submit
+ * the signature via the /execute endpoint.
  */
-export function tradFiTradfiCancelOrder(
+export function traditionalInvestingTraditionalInvestingCancelOrder(
   client: CompassApiSDKCore,
-  request: components.TradFiCancelOrderRequest,
+  request: components.TraditionalInvestingCancelOrderRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.TradFiOrderResponse,
+    components.TraditionalInvestingSignableActionResponse,
     | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
@@ -61,12 +61,12 @@ export function tradFiTradfiCancelOrder(
 
 async function $do(
   client: CompassApiSDKCore,
-  request: components.TradFiCancelOrderRequest,
+  request: components.TraditionalInvestingCancelOrderRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      components.TradFiOrderResponse,
+      components.TraditionalInvestingSignableActionResponse,
       | errors.HTTPValidationError
       | CompassAPISDKError
       | ResponseValidationError
@@ -82,7 +82,10 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => components.TradFiCancelOrderRequest$outboundSchema.parse(value),
+    (value) =>
+      components.TraditionalInvestingCancelOrderRequest$outboundSchema.parse(
+        value,
+      ),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -91,7 +94,7 @@ async function $do(
   const payload = parsed.value;
   const body = encodeJSON("body", payload, { explode: true });
 
-  const path = pathToFunc("/v2/tradfi/cancel_order")();
+  const path = pathToFunc("/v2/traditional_investing/cancel_order")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -105,7 +108,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "v2_tradfi_cancel_order",
+    operationID: "v2_traditional_investing_cancel_order",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -148,7 +151,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.TradFiOrderResponse,
+    components.TraditionalInvestingSignableActionResponse,
     | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
@@ -159,7 +162,10 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, components.TradFiOrderResponse$inboundSchema),
+    M.json(
+      200,
+      components.TraditionalInvestingSignableActionResponse$inboundSchema,
+    ),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/{tradFiTradfiCreateAccount.ts → traditionalInvestingTraditionalInvestingDeposit.ts}

@@ -26,24 +26,22 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create TradFi account
+ * Deposit USDC to traditional investments account
  *
  * @remarks
- * Create a TradFi product account on HyperEVM.
+ * Prepare a USDC deposit from Arbitrum via EIP-2612 Permit.
  *
- * 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).
+ * Returns EIP-712 typed data for the user to sign off-chain (no gas needed).
+ * After signing, send the permit signature to the deposit/execute endpoint,
+ * where a gas sponsor calls batchedDepositWithPermit on the HL Bridge2.
  */
-export function tradFiTradfiCreateAccount(
+export function traditionalInvestingTraditionalInvestingDeposit(
   client: CompassApiSDKCore,
-  request: components.CreateTradFiAccountRequest,
+  request: components.TraditionalInvestingDepositRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.CreateTradFiAccountResponse,
+    components.TraditionalInvestingDepositResponse,
     | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
@@ -64,12 +62,12 @@ export function tradFiTradfiCreateAccount(
 
 async function $do(
   client: CompassApiSDKCore,
-  request: components.CreateTradFiAccountRequest,
+  request: components.TraditionalInvestingDepositRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      components.CreateTradFiAccountResponse,
+      components.TraditionalInvestingDepositResponse,
       | errors.HTTPValidationError
       | CompassAPISDKError
       | ResponseValidationError
@@ -86,7 +84,7 @@ async function $do(
   const parsed = safeParse(
     request,
     (value) =>
-      components.CreateTradFiAccountRequest$outboundSchema.parse(value),
+      components.TraditionalInvestingDepositRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -95,7 +93,7 @@ async function $do(
   const payload = parsed.value;
   const body = encodeJSON("body", payload, { explode: true });
 
-  const path = pathToFunc("/v2/tradfi/create_account")();
+  const path = pathToFunc("/v2/traditional_investing/deposit")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -109,7 +107,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "v2_tradfi_create_account",
+    operationID: "v2_traditional_investing_deposit",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -152,7 +150,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.CreateTradFiAccountResponse,
+    components.TraditionalInvestingDepositResponse,
     | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
@@ -163,7 +161,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, components.CreateTradFiAccountResponse$inboundSchema),
+    M.json(200, components.TraditionalInvestingDepositResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/{tradFiTradfiDeposit.ts → traditionalInvestingTraditionalInvestingExecute.ts}

@@ -26,23 +26,22 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Deposit USDC to TradFi account
+ * Execute signed action
  *
  * @remarks
- * Bridge USDC from Arbitrum to the TradFi account on HyperEVM.
+ * Submit a signed Hyperliquid action for execution.
  *
- * 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.
+ * 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.
  */
-export function tradFiTradfiDeposit(
+export function traditionalInvestingTraditionalInvestingExecute(
   client: CompassApiSDKCore,
-  request: components.TradFiDepositRequest,
+  request: components.TraditionalInvestingExecuteRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.TradFiDepositResponse,
+    components.TraditionalInvestingExecuteResponse,
     | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
@@ -63,12 +62,12 @@ export function tradFiTradfiDeposit(
 
 async function $do(
   client: CompassApiSDKCore,
-  request: components.TradFiDepositRequest,
+  request: components.TraditionalInvestingExecuteRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      components.TradFiDepositResponse,
+      components.TraditionalInvestingExecuteResponse,
       | errors.HTTPValidationError
       | CompassAPISDKError
       | ResponseValidationError
@@ -84,7 +83,8 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => components.TradFiDepositRequest$outboundSchema.parse(value),
+    (value) =>
+      components.TraditionalInvestingExecuteRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -93,7 +93,7 @@ async function $do(
   const payload = parsed.value;
   const body = encodeJSON("body", payload, { explode: true });
 
-  const path = pathToFunc("/v2/tradfi/deposit")();
+  const path = pathToFunc("/v2/traditional_investing/execute")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -107,7 +107,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "v2_tradfi_deposit",
+    operationID: "v2_traditional_investing_execute",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -150,7 +150,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.TradFiDepositResponse,
+    components.TraditionalInvestingExecuteResponse,
     | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
@@ -161,7 +161,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, components.TradFiDepositResponse$inboundSchema),
+    M.json(200, components.TraditionalInvestingExecuteResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/{tradFiTradfiLimitOrder.ts → traditionalInvestingTraditionalInvestingLimitOrder.ts}

@@ -29,21 +29,18 @@ import { Result } from "../types/fp.js";
  * Place limit order
  *
  * @remarks
- * Place a limit order on a TradFi perpetual futures market.
+ * Prepare a limit order on a traditional investments 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.
+ * 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.
  */
-export function tradFiTradfiLimitOrder(
+export function traditionalInvestingTraditionalInvestingLimitOrder(
   client: CompassApiSDKCore,
-  request: components.TradFiLimitOrderRequest,
+  request: components.TraditionalInvestingLimitOrderRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.TradFiOrderResponse,
+    components.TraditionalInvestingSignableActionResponse,
     | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
@@ -64,12 +61,12 @@ export function tradFiTradfiLimitOrder(
 
 async function $do(
   client: CompassApiSDKCore,
-  request: components.TradFiLimitOrderRequest,
+  request: components.TraditionalInvestingLimitOrderRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      components.TradFiOrderResponse,
+      components.TraditionalInvestingSignableActionResponse,
       | errors.HTTPValidationError
       | CompassAPISDKError
       | ResponseValidationError
@@ -85,7 +82,10 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => components.TradFiLimitOrderRequest$outboundSchema.parse(value),
+    (value) =>
+      components.TraditionalInvestingLimitOrderRequest$outboundSchema.parse(
+        value,
+      ),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -94,7 +94,7 @@ async function $do(
   const payload = parsed.value;
   const body = encodeJSON("body", payload, { explode: true });
 
-  const path = pathToFunc("/v2/tradfi/limit_order")();
+  const path = pathToFunc("/v2/traditional_investing/limit_order")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -108,7 +108,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "v2_tradfi_limit_order",
+    operationID: "v2_traditional_investing_limit_order",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -151,7 +151,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.TradFiOrderResponse,
+    components.TraditionalInvestingSignableActionResponse,
     | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
@@ -162,7 +162,10 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, components.TradFiOrderResponse$inboundSchema),
+    M.json(
+      200,
+      components.TraditionalInvestingSignableActionResponse$inboundSchema,
+    ),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/{tradFiTradfiMarketOrder.ts → traditionalInvestingTraditionalInvestingMarketOrder.ts}

@@ -29,22 +29,19 @@ import { Result } from "../types/fp.js";
  * Place market order
  *
  * @remarks
- * Place a market order on a TradFi perpetual futures market.
+ * Prepare a market order on a traditional investments 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.
+ * 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.
  */
-export function tradFiTradfiMarketOrder(
+export function traditionalInvestingTraditionalInvestingMarketOrder(
   client: CompassApiSDKCore,
-  request: components.TradFiMarketOrderRequest,
+  request: components.TraditionalInvestingMarketOrderRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.TradFiOrderResponse,
+    components.TraditionalInvestingSignableActionResponse,
     | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
@@ -65,12 +62,12 @@ export function tradFiTradfiMarketOrder(
 
 async function $do(
   client: CompassApiSDKCore,
-  request: components.TradFiMarketOrderRequest,
+  request: components.TraditionalInvestingMarketOrderRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      components.TradFiOrderResponse,
+      components.TraditionalInvestingSignableActionResponse,
       | errors.HTTPValidationError
       | CompassAPISDKError
       | ResponseValidationError
@@ -86,7 +83,10 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => components.TradFiMarketOrderRequest$outboundSchema.parse(value),
+    (value) =>
+      components.TraditionalInvestingMarketOrderRequest$outboundSchema.parse(
+        value,
+      ),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -95,7 +95,7 @@ async function $do(
   const payload = parsed.value;
   const body = encodeJSON("body", payload, { explode: true });
 
-  const path = pathToFunc("/v2/tradfi/market_order")();
+  const path = pathToFunc("/v2/traditional_investing/market_order")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -109,7 +109,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "v2_tradfi_market_order",
+    operationID: "v2_traditional_investing_market_order",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -152,7 +152,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.TradFiOrderResponse,
+    components.TraditionalInvestingSignableActionResponse,
     | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
@@ -163,7 +163,10 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, components.TradFiOrderResponse$inboundSchema),
+    M.json(
+      200,
+      components.TraditionalInvestingSignableActionResponse$inboundSchema,
+    ),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),