@compass-labs/api-sdk 2.2.34-rc.9 → 2.2.34

package/src/funcs/traditionalInvestingTraditionalInvestingEnsureLeverage.ts

@@ -0,0 +1,180 @@
+/*
+ * 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";
+
+/**
+ * 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.
+ */
+export function traditionalInvestingTraditionalInvestingEnsureLeverage(
+  client: CompassApiSDKCore,
+  request: components.TraditionalInvestingEnsureLeverageRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.TraditionalInvestingEnsureLeverageResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.TraditionalInvestingEnsureLeverageRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.TraditionalInvestingEnsureLeverageResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.TraditionalInvestingEnsureLeverageRequest$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/ensure_leverage")();
+
+  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_ensure_leverage",
+    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.TraditionalInvestingEnsureLeverageResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      components.TraditionalInvestingEnsureLeverageResponse$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/index.ts

@@ -249,6 +249,8 @@ export * from "./traditionalinvestingdepositrequest.js";
 export * from "./traditionalinvestingdepositresponse.js";
 export * from "./traditionalinvestingenableunifiedaccountrequest.js";
 export * from "./traditionalinvestingenableunifiedaccountresponse.js";
+export * from "./traditionalinvestingensureleveragerequest.js";
+export * from "./traditionalinvestingensureleverageresponse.js";
 export * from "./traditionalinvestingexecuterequest.js";
 export * from "./traditionalinvestingexecuteresponse.js";
 export * from "./traditionalinvestinglimitorderrequest.js";

package/src/models/components/traditionalinvestingensureleveragerequest.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Request to check and set leverage to 1x cross on a traditional investing asset.
+ */
+export type TraditionalInvestingEnsureLeverageRequest = {
+  /**
+   * User's EOA address
+   */
+  owner: string;
+  /**
+   * Asset ticker (e.g. 'AAPL', 'CL')
+   */
+  asset: string;
+};
+
+/** @internal */
+export type TraditionalInvestingEnsureLeverageRequest$Outbound = {
+  owner: string;
+  asset: string;
+};
+
+/** @internal */
+export const TraditionalInvestingEnsureLeverageRequest$outboundSchema:
+  z.ZodType<
+    TraditionalInvestingEnsureLeverageRequest$Outbound,
+    z.ZodTypeDef,
+    TraditionalInvestingEnsureLeverageRequest
+  > = z.object({
+    owner: z.string(),
+    asset: z.string(),
+  });
+
+export function traditionalInvestingEnsureLeverageRequestToJSON(
+  traditionalInvestingEnsureLeverageRequest:
+    TraditionalInvestingEnsureLeverageRequest,
+): string {
+  return JSON.stringify(
+    TraditionalInvestingEnsureLeverageRequest$outboundSchema.parse(
+      traditionalInvestingEnsureLeverageRequest,
+    ),
+  );
+}

package/src/models/components/traditionalinvestingensureleverageresponse.ts

@@ -0,0 +1,67 @@
+/*
+ * 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";
+
+/**
+ * Returned by the ensure_leverage endpoint.
+ *
+ * @remarks
+ *
+ * If the asset is already at 1x cross leverage, typed_data/action/nonce are null.
+ * If not (or no position exists), they contain the EIP-712 payload the user must sign.
+ */
+export type TraditionalInvestingEnsureLeverageResponse = {
+  /**
+   * True if leverage is already 1x cross, false if update needed
+   */
+  leverageOk: boolean;
+  /**
+   * EIP-712 typed data for wallet signing, or null if already 1x cross
+   */
+  typedData?: { [k: string]: any } | null | undefined;
+  /**
+   * Raw Hyperliquid action (passed back to the execute endpoint), or null
+   */
+  action?: { [k: string]: any } | null | undefined;
+  /**
+   * Timestamp-based nonce, or null if no action needed
+   */
+  nonce?: number | null | undefined;
+};
+
+/** @internal */
+export const TraditionalInvestingEnsureLeverageResponse$inboundSchema:
+  z.ZodType<TraditionalInvestingEnsureLeverageResponse, z.ZodTypeDef, unknown> =
+    z.object({
+      leverage_ok: z.boolean(),
+      typed_data: z.nullable(z.record(z.any())).optional(),
+      action: z.nullable(z.record(z.any())).optional(),
+      nonce: z.nullable(z.number().int()).optional(),
+    }).transform((v) => {
+      return remap$(v, {
+        "leverage_ok": "leverageOk",
+        "typed_data": "typedData",
+      });
+    });
+
+export function traditionalInvestingEnsureLeverageResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  TraditionalInvestingEnsureLeverageResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TraditionalInvestingEnsureLeverageResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'TraditionalInvestingEnsureLeverageResponse' from JSON`,
+  );
+}

package/src/sdk/traditionalinvesting.ts

@@ -6,6 +6,7 @@ import { traditionalInvestingTraditionalInvestingApproveBuilderFee } from "../fu
 import { traditionalInvestingTraditionalInvestingCancelOrder } from "../funcs/traditionalInvestingTraditionalInvestingCancelOrder.js";
 import { traditionalInvestingTraditionalInvestingDeposit } from "../funcs/traditionalInvestingTraditionalInvestingDeposit.js";
 import { traditionalInvestingTraditionalInvestingEnableUnifiedAccount } from "../funcs/traditionalInvestingTraditionalInvestingEnableUnifiedAccount.js";
+import { traditionalInvestingTraditionalInvestingEnsureLeverage } from "../funcs/traditionalInvestingTraditionalInvestingEnsureLeverage.js";
 import { traditionalInvestingTraditionalInvestingExecute } from "../funcs/traditionalInvestingTraditionalInvestingExecute.js";
 import { traditionalInvestingTraditionalInvestingLimitOrder } from "../funcs/traditionalInvestingTraditionalInvestingLimitOrder.js";
 import { traditionalInvestingTraditionalInvestingMarketOrder } from "../funcs/traditionalInvestingTraditionalInvestingMarketOrder.js";
@@ -232,4 +233,26 @@ export class TraditionalInvesting extends ClientSDK {
       ),
     );
   }
+
+  /**
+   * 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 traditionalInvestingEnsureLeverage(
+    request: components.TraditionalInvestingEnsureLeverageRequest,
+    options?: RequestOptions,
+  ): Promise<components.TraditionalInvestingEnsureLeverageResponse> {
+    return unwrapAsync(traditionalInvestingTraditionalInvestingEnsureLeverage(
+      this,
+      request,
+      options,
+    ));
+  }
 }