@nktkas/hyperliquid 0.30.3 → 0.32.0

package/src/src/api/exchange/_methods/cWithdraw.ts

@@ -1,151 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Hex, UnsignedInteger } from "../../_schemas.js";
-import { ErrorResponse, HyperliquidChainSchema, SignatureSchema, SuccessResponse } from "./_base/commonSchemas.js";
-
-/**
- * Transfer native token from staking into the user's spot account.
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#withdraw-from-staking
- */
-export const CWithdrawRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Action to perform. */
-      action: v.pipe(
-        v.object({
-          /** Type of action. */
-          type: v.pipe(
-            v.literal("cWithdraw"),
-            v.description("Type of action."),
-          ),
-          /** Chain ID in hex format for EIP-712 signing. */
-          signatureChainId: v.pipe(
-            Hex,
-            v.description("Chain ID in hex format for EIP-712 signing."),
-          ),
-          /** HyperLiquid network type. */
-          hyperliquidChain: v.pipe(
-            HyperliquidChainSchema,
-            v.description("HyperLiquid network type."),
-          ),
-          /** Amount of wei to withdraw from staking balance (float * 1e8). */
-          wei: v.pipe(
-            UnsignedInteger,
-            v.minValue(1),
-            v.description("Amount of wei to withdraw from staking balance (float * 1e8)."),
-          ),
-          /** Nonce (timestamp in ms) used to prevent replay attacks. */
-          nonce: v.pipe(
-            UnsignedInteger,
-            v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
-          ),
-        }),
-        v.description("Action to perform."),
-      ),
-      /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: v.pipe(
-        UnsignedInteger,
-        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
-      ),
-      /** ECDSA signature components. */
-      signature: v.pipe(
-        SignatureSchema,
-        v.description("ECDSA signature components."),
-      ),
-    }),
-    v.description("Transfer native token from staking into the user's spot account."),
-  );
-})();
-export type CWithdrawRequest = v.InferOutput<typeof CWithdrawRequest>;
-
-/**
- * Successful response without specific data or error response.
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#withdraw-from-staking
- */
-export const CWithdrawResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.union([SuccessResponse, ErrorResponse]),
-    v.description("Successful response without specific data or error response."),
-  );
-})();
-export type CWithdrawResponse = v.InferOutput<typeof CWithdrawResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import { type ExchangeConfig, executeUserSignedAction, type ExtractRequestOptions } from "./_base/execute.js";
-import type { ExcludeErrorResponse } from "./_base/errors.js";
-
-/** Schema for user-provided action parameters (excludes system fields). */
-const CWithdrawParameters = /* @__PURE__ */ (() => {
-  return v.omit(
-    v.object(CWithdrawRequest.entries.action.entries),
-    ["type", "signatureChainId", "hyperliquidChain", "nonce"],
-  );
-})();
-/** Action parameters for the {@linkcode cWithdraw} function. */
-export type CWithdrawParameters = v.InferInput<typeof CWithdrawParameters>;
-
-/** Request options for the {@linkcode cWithdraw} function. */
-export type CWithdrawOptions = ExtractRequestOptions<v.InferInput<typeof CWithdrawRequest>>;
-
-/** Successful variant of {@linkcode CWithdrawResponse} without errors. */
-export type CWithdrawSuccessResponse = ExcludeErrorResponse<CWithdrawResponse>;
-
-/** EIP-712 types for the {@linkcode cWithdraw} function. */
-export const CWithdrawTypes = {
-  "HyperliquidTransaction:CWithdraw": [
-    { name: "hyperliquidChain", type: "string" },
-    { name: "wei", type: "uint64" },
-    { name: "nonce", type: "uint64" },
-  ],
-};
-
-/**
- * Transfer native token from staking into the user's spot account.
- *
- * @param config - General configuration for Exchange API requests.
- * @param params - Parameters specific to the API request.
- * @param opts - Request execution options.
- *
- * @returns Successful response without specific data.
- *
- * @throws {ValiError} When the request parameters fail validation (before sending).
- * @throws {TransportError} When the transport layer throws an error.
- * @throws {ApiRequestError} When the API returns an unsuccessful response.
- *
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { cWithdraw } from "@nktkas/hyperliquid/api/exchange";
- * import { privateKeyToAccount } from "npm:viem/accounts";
- *
- * const wallet = privateKeyToAccount("0x..."); // viem or ethers
- * const transport = new HttpTransport(); // or `WebSocketTransport`
- *
- * await cWithdraw(
- *   { transport, wallet },
- *   { wei: 1 * 1e8 },
- * );
- * ```
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#withdraw-from-staking
- */
-export function cWithdraw(
-  config: ExchangeConfig,
-  params: CWithdrawParameters,
-  opts?: CWithdrawOptions,
-): Promise<CWithdrawSuccessResponse> {
-  const action = v.parse(CWithdrawParameters, params);
-  return executeUserSignedAction(
-    config,
-    { type: "cWithdraw", ...action },
-    CWithdrawTypes,
-    opts,
-  );
-}

package/src/src/api/exchange/_methods/cancel.ts

@@ -1,187 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Address, UnsignedInteger } from "../../_schemas.js";
-import { SignatureSchema } from "./_base/commonSchemas.js";
-
-/**
- * Cancel order(s).
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s
- */
-export const CancelRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Action to perform. */
-      action: v.pipe(
-        v.object({
-          /** Type of action. */
-          type: v.pipe(
-            v.literal("cancel"),
-            v.description("Type of action."),
-          ),
-          /** Orders to cancel by asset and order ID. */
-          cancels: v.pipe(
-            v.array(
-              v.object({
-                /** Asset ID. */
-                a: v.pipe(
-                  UnsignedInteger,
-                  v.description("Asset ID."),
-                ),
-                /** Order ID. */
-                o: v.pipe(
-                  UnsignedInteger,
-                  v.description("Order ID."),
-                ),
-              }),
-            ),
-            v.description("Orders to cancel by asset and order ID."),
-          ),
-        }),
-        v.description("Action to perform."),
-      ),
-      /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: v.pipe(
-        UnsignedInteger,
-        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
-      ),
-      /** ECDSA signature components. */
-      signature: v.pipe(
-        SignatureSchema,
-        v.description("ECDSA signature components."),
-      ),
-      /** Vault address (for vault trading). */
-      vaultAddress: v.pipe(
-        v.optional(Address),
-        v.description("Vault address (for vault trading)."),
-      ),
-      /** Expiration time of the action. */
-      expiresAfter: v.pipe(
-        v.optional(UnsignedInteger),
-        v.description("Expiration time of the action."),
-      ),
-    }),
-    v.description("Cancel order(s)."),
-  );
-})();
-export type CancelRequest = v.InferOutput<typeof CancelRequest>;
-
-/**
- * Response for order cancellation.
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s
- */
-export const CancelResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Successful status. */
-      status: v.pipe(
-        v.literal("ok"),
-        v.description("Successful status."),
-      ),
-      /** Response details. */
-      response: v.pipe(
-        v.object({
-          /** Type of response. */
-          type: v.pipe(
-            v.literal("cancel"),
-            v.description("Type of response."),
-          ),
-          /** Specific data. */
-          data: v.pipe(
-            v.object({
-              /** Array of statuses for each canceled order. */
-              statuses: v.pipe(
-                v.array(
-                  v.union([
-                    v.literal("success"),
-                    v.object({
-                      /** Error message returned by the exchange. */
-                      error: v.pipe(
-                        v.string(),
-                        v.description("Error message returned by the exchange."),
-                      ),
-                    }),
-                  ]),
-                ),
-                v.description("Array of statuses for each canceled order."),
-              ),
-            }),
-            v.description("Specific data."),
-          ),
-        }),
-        v.description("Response details."),
-      ),
-    }),
-    v.description("Response for order cancellation."),
-  );
-})();
-export type CancelResponse = v.InferOutput<typeof CancelResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import { type ExchangeConfig, executeL1Action, type ExtractRequestOptions } from "./_base/execute.js";
-import type { ExcludeErrorResponse } from "./_base/errors.js";
-
-/** Schema for user-provided action parameters (excludes system fields). */
-const CancelParameters = /* @__PURE__ */ (() => {
-  return v.omit(
-    v.object(CancelRequest.entries.action.entries),
-    ["type"],
-  );
-})();
-/** Action parameters for the {@linkcode cancel} function. */
-export type CancelParameters = v.InferInput<typeof CancelParameters>;
-
-/** Request options for the {@linkcode cancel} function. */
-export type CancelOptions = ExtractRequestOptions<v.InferInput<typeof CancelRequest>>;
-
-/** Successful variant of {@linkcode CancelResponse} without errors. */
-export type CancelSuccessResponse = ExcludeErrorResponse<CancelResponse>;
-
-/**
- * Cancel order(s).
- *
- * @param config - General configuration for Exchange API requests.
- * @param params - Parameters specific to the API request.
- * @param opts - Request execution options.
- *
- * @returns Successful variant of {@link CancelResponse} without error statuses.
- *
- * @throws {ValiError} When the request parameters fail validation (before sending).
- * @throws {TransportError} When the transport layer throws an error.
- * @throws {ApiRequestError} When the API returns an unsuccessful response.
- *
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { cancel } from "@nktkas/hyperliquid/api/exchange";
- * import { privateKeyToAccount } from "npm:viem/accounts";
- *
- * const wallet = privateKeyToAccount("0x..."); // viem or ethers
- * const transport = new HttpTransport(); // or `WebSocketTransport`
- *
- * const data = await cancel(
- *   { transport, wallet },
- *   {
- *     cancels: [
- *       { a: 0, o: 123 },
- *     ],
- *   },
- * );
- * ```
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s
- */
-export function cancel(
-  config: ExchangeConfig,
-  params: CancelParameters,
-  opts?: CancelOptions,
-): Promise<CancelSuccessResponse> {
-  const action = v.parse(CancelParameters, params);
-  return executeL1Action(config, { type: "cancel", ...action }, opts);
-}

package/src/src/api/exchange/_methods/cancelByCloid.ts

@@ -1,149 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Address, Cloid, UnsignedInteger } from "../../_schemas.js";
-import { SignatureSchema } from "./_base/commonSchemas.js";
-import { CancelResponse } from "./cancel.js";
-
-/**
- * Cancel order(s) by cloid.
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s-by-cloid
- */
-export const CancelByCloidRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Action to perform. */
-      action: v.pipe(
-        v.object({
-          /** Type of action. */
-          type: v.pipe(
-            v.literal("cancelByCloid"),
-            v.description("Type of action."),
-          ),
-          /** Orders to cancel by asset and client order ID. */
-          cancels: v.pipe(
-            v.array(
-              v.object({
-                /** Asset ID. */
-                asset: v.pipe(
-                  UnsignedInteger,
-                  v.description("Asset ID."),
-                ),
-                /** Client Order ID. */
-                cloid: v.pipe(
-                  Cloid,
-                  v.description("Client Order ID."),
-                ),
-              }),
-            ),
-            v.description("Orders to cancel by asset and client order ID."),
-          ),
-        }),
-        v.description("Action to perform."),
-      ),
-      /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: v.pipe(
-        UnsignedInteger,
-        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
-      ),
-      /** ECDSA signature components. */
-      signature: v.pipe(
-        SignatureSchema,
-        v.description("ECDSA signature components."),
-      ),
-      /** Vault address (for vault trading). */
-      vaultAddress: v.pipe(
-        v.optional(Address),
-        v.description("Vault address (for vault trading)."),
-      ),
-      /** Expiration time of the action. */
-      expiresAfter: v.pipe(
-        v.optional(UnsignedInteger),
-        v.description("Expiration time of the action."),
-      ),
-    }),
-    v.description("Cancel order(s) by cloid."),
-  );
-})();
-export type CancelByCloidRequest = v.InferOutput<typeof CancelByCloidRequest>;
-
-/**
- * Response for order cancellation by cloid.
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s-by-cloid
- */
-export const CancelByCloidResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    CancelResponse,
-    v.description("Response for order cancellation by cloid."),
-  );
-})();
-export type CancelByCloidResponse = v.InferOutput<typeof CancelByCloidResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import { type ExchangeConfig, executeL1Action, type ExtractRequestOptions } from "./_base/execute.js";
-import type { ExcludeErrorResponse } from "./_base/errors.js";
-
-/** Schema for user-provided action parameters (excludes system fields). */
-const CancelByCloidParameters = /* @__PURE__ */ (() => {
-  return v.omit(
-    v.object(CancelByCloidRequest.entries.action.entries),
-    ["type"],
-  );
-})();
-/** Action parameters for the {@linkcode cancelByCloid} function. */
-export type CancelByCloidParameters = v.InferInput<typeof CancelByCloidParameters>;
-
-/** Request options for the {@linkcode cancelByCloid} function. */
-export type CancelByCloidOptions = ExtractRequestOptions<v.InferInput<typeof CancelByCloidRequest>>;
-
-/** Successful variant of {@linkcode CancelByCloidResponse} without errors. */
-export type CancelByCloidSuccessResponse = ExcludeErrorResponse<CancelByCloidResponse>;
-
-/**
- * Cancel order(s) by cloid.
- *
- * @param config - General configuration for Exchange API requests.
- * @param params - Parameters specific to the API request.
- * @param opts - Request execution options.
- *
- * @returns Successful variant of {@link CancelResponse} without error statuses.
- *
- * @throws {ValiError} When the request parameters fail validation (before sending).
- * @throws {TransportError} When the transport layer throws an error.
- * @throws {ApiRequestError} When the API returns an unsuccessful response.
- *
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { cancelByCloid } from "@nktkas/hyperliquid/api/exchange";
- * import { privateKeyToAccount } from "npm:viem/accounts";
- *
- * const wallet = privateKeyToAccount("0x..."); // viem or ethers
- * const transport = new HttpTransport(); // or `WebSocketTransport`
- *
- * const data = await cancelByCloid(
- *   { transport, wallet },
- *   {
- *     cancels: [
- *       { asset: 0, cloid: "0x..." },
- *     ],
- *   },
- * );
- * ```
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#cancel-order-s-by-cloid
- */
-export function cancelByCloid(
-  config: ExchangeConfig,
-  params: CancelByCloidParameters,
-  opts?: CancelByCloidOptions,
-): Promise<CancelByCloidSuccessResponse> {
-  const action = v.parse(CancelByCloidParameters, params);
-  return executeL1Action(config, { type: "cancelByCloid", ...action }, opts);
-}

package/src/src/api/exchange/_methods/claimRewards.ts

@@ -1,96 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { UnsignedInteger } from "../../_schemas.js";
-import { ErrorResponse, SignatureSchema, SuccessResponse } from "./_base/commonSchemas.js";
-
-/** Claim rewards from referral program. */
-export const ClaimRewardsRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Action to perform. */
-      action: v.pipe(
-        v.object({
-          /** Type of action. */
-          type: v.pipe(
-            v.literal("claimRewards"),
-            v.description("Type of action."),
-          ),
-        }),
-        v.description("Action to perform."),
-      ),
-      /** Nonce (timestamp in ms) used to prevent replay attacks. */
-      nonce: v.pipe(
-        UnsignedInteger,
-        v.description("Nonce (timestamp in ms) used to prevent replay attacks."),
-      ),
-      /** ECDSA signature components. */
-      signature: v.pipe(
-        SignatureSchema,
-        v.description("ECDSA signature components."),
-      ),
-      /** Expiration time of the action. */
-      expiresAfter: v.pipe(
-        v.optional(UnsignedInteger),
-        v.description("Expiration time of the action."),
-      ),
-    }),
-    v.description("Claim rewards from referral program."),
-  );
-})();
-export type ClaimRewardsRequest = v.InferOutput<typeof ClaimRewardsRequest>;
-
-/** Successful response without specific data or error response. */
-export const ClaimRewardsResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.union([SuccessResponse, ErrorResponse]),
-    v.description("Successful response without specific data or error response."),
-  );
-})();
-export type ClaimRewardsResponse = v.InferOutput<typeof ClaimRewardsResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import { type ExchangeConfig, executeL1Action, type ExtractRequestOptions } from "./_base/execute.js";
-import type { ExcludeErrorResponse } from "./_base/errors.js";
-
-/** Request options for the {@linkcode claimRewards} function. */
-export type ClaimRewardsOptions = ExtractRequestOptions<v.InferInput<typeof ClaimRewardsRequest>>;
-
-/** Successful variant of {@linkcode ClaimRewardsResponse} without errors. */
-export type ClaimRewardsSuccessResponse = ExcludeErrorResponse<ClaimRewardsResponse>;
-
-/**
- * Claim rewards from referral program.
- *
- * @param opts - Request execution options.
- *
- * @returns Successful response without specific data.
- *
- * @throws {ValiError} When the request parameters fail validation (before sending).
- * @throws {TransportError} When the transport layer throws an error.
- * @throws {ApiRequestError} When the API returns an unsuccessful response.
- *
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { claimRewards } from "@nktkas/hyperliquid/api/exchange";
- * import { privateKeyToAccount } from "npm:viem/accounts";
- *
- * const wallet = privateKeyToAccount("0x..."); // viem or ethers
- * const transport = new HttpTransport(); // or `WebSocketTransport`
- *
- * await claimRewards({ transport, wallet });
- * ```
- */
-export function claimRewards(
-  config: ExchangeConfig,
-  opts?: ClaimRewardsOptions,
-): Promise<ClaimRewardsSuccessResponse> {
-  return executeL1Action(config, { type: "claimRewards" }, opts);
-}