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

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,
+    ));
+  }
 }