@nktkas/hyperliquid 0.26.0 → 0.27.1

package/src/api/exchange/createSubAccount.ts

@@ -1,144 +0,0 @@
-import * as v from "valibot";
-import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_base.ts";
-import {
-  type ExchangeRequestConfig,
-  executeL1Action,
-  type ExtractRequestAction,
-  type ExtractRequestOptions,
-  type MultiSignRequestConfig,
-  Signature,
-} from "./_base/mod.ts";
-
-// -------------------- Schemas --------------------
-
-/**
- * Create a sub-account.
- * @see null
- */
-export const CreateSubAccountRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Action to perform. */
-      action: v.pipe(
-        v.object({
-          /** Type of action. */
-          type: v.pipe(
-            v.literal("createSubAccount"),
-            v.description("Type of action."),
-          ),
-          /** Sub-account name. */
-          name: v.pipe(
-            v.string(),
-            v.minLength(1),
-            v.description("Sub-account name."),
-          ),
-        }),
-        v.description("Action to perform."),
-      ),
-      /** Unique request identifier (current timestamp in ms). */
-      nonce: v.pipe(
-        UnsignedInteger,
-        v.description("Unique request identifier (current timestamp in ms)."),
-      ),
-      /** Cryptographic signature. */
-      signature: v.pipe(
-        Signature,
-        v.description("Cryptographic signature."),
-      ),
-      /** Expiration time of the action. */
-      expiresAfter: v.pipe(
-        v.optional(UnsignedInteger),
-        v.description("Expiration time of the action."),
-      ),
-    }),
-    v.description("Create a sub-account."),
-  );
-})();
-export type CreateSubAccountRequest = v.InferOutput<typeof CreateSubAccountRequest>;
-
-/** Response for creating a sub-account. */
-export const CreateSubAccountResponse = /* @__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("createSubAccount"),
-            v.description("Type of response."),
-          ),
-          /** Sub-account address. */
-          data: v.pipe(
-            Address,
-            v.description("Sub-account address."),
-          ),
-        }),
-        v.description("Response details."),
-      ),
-    }),
-    v.description("Response for creating a sub-account."),
-  );
-})();
-export type CreateSubAccountResponse = v.InferOutput<typeof CreateSubAccountResponse>;
-
-// -------------------- Function --------------------
-
-/** Action parameters for the {@linkcode createSubAccount} function. */
-export type CreateSubAccountParameters = ExtractRequestAction<v.InferInput<typeof CreateSubAccountRequest>>;
-/** Request options for the {@linkcode createSubAccount} function. */
-export type CreateSubAccountOptions = ExtractRequestOptions<v.InferInput<typeof CreateSubAccountRequest>>;
-
-/**
- * Create a sub-account.
- * @param config - General configuration for Exchange API requests.
- * @param params - Parameters specific to the API request.
- * @param opts - Request execution options.
- * @returns Response for creating a sub-account.
- *
- * @throws {ApiRequestError} When the API returns an unsuccessful response.
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @see null
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { createSubAccount } 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 createSubAccount(
- *   { transport, wallet },
- *   { name: "..." },
- * );
- * ```
- */
-export async function createSubAccount(
-  config: ExchangeRequestConfig | MultiSignRequestConfig,
-  params: DeepImmutable<CreateSubAccountParameters>,
-  opts?: CreateSubAccountOptions,
-): Promise<CreateSubAccountResponse> {
-  const request = parser(CreateSubAccountRequest)({
-    action: {
-      type: "createSubAccount",
-      ...params,
-    },
-    nonce: 0, // Placeholder; actual nonce generated in `executeL1Action`
-    signature: { // Placeholder; actual signature generated in `executeL1Action`
-      r: "0x0000000000000000000000000000000000000000000000000000000000000000",
-      s: "0x0000000000000000000000000000000000000000000000000000000000000000",
-      v: 27,
-    },
-    expiresAfter: typeof config.defaultExpiresAfter === "number"
-      ? config.defaultExpiresAfter
-      : await config.defaultExpiresAfter?.(),
-  });
-  return await executeL1Action(config, request, opts?.signal);
-}

package/src/api/exchange/createVault.ts

@@ -1,165 +0,0 @@
-import * as v from "valibot";
-import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_base.ts";
-import {
-  type ExchangeRequestConfig,
-  executeL1Action,
-  type ExtractRequestAction,
-  type ExtractRequestOptions,
-  type MultiSignRequestConfig,
-  Signature,
-} from "./_base/mod.ts";
-
-// -------------------- Schemas --------------------
-
-/**
- * Create a vault.
- * @see null
- */
-export const CreateVaultRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Action to perform. */
-      action: v.pipe(
-        v.object({
-          /** Type of action. */
-          type: v.pipe(
-            v.literal("createVault"),
-            v.description("Type of action."),
-          ),
-          /** Vault name. */
-          name: v.pipe(
-            v.string(),
-            v.minLength(3),
-            v.description("Vault name."),
-          ),
-          /** Vault description. */
-          description: v.pipe(
-            v.string(),
-            v.minLength(10),
-            v.description("Vault description."),
-          ),
-          /** Initial balance (float * 1e6). */
-          initialUsd: v.pipe(
-            UnsignedInteger,
-            v.minValue(100000000), // 100 USDC
-            v.description("Initial balance (float * 1e6)."),
-          ),
-          /** Unique request identifier (current timestamp in ms) (default: Date.now()). */
-          nonce: v.pipe(
-            v.optional(UnsignedInteger, () => Date.now()), // default value is allowed because this is an L1 action
-            v.description("Unique request identifier (current timestamp in ms)."),
-          ),
-        }),
-        v.description("Action to perform."),
-      ),
-      /** Unique request identifier (current timestamp in ms). */
-      nonce: v.pipe(
-        UnsignedInteger,
-        v.description("Unique request identifier (current timestamp in ms)."),
-      ),
-      /** Cryptographic signature. */
-      signature: v.pipe(
-        Signature,
-        v.description("Cryptographic signature."),
-      ),
-      /** Expiration time of the action. */
-      expiresAfter: v.pipe(
-        v.optional(UnsignedInteger),
-        v.description("Expiration time of the action."),
-      ),
-    }),
-    v.description("Create a vault."),
-  );
-})();
-export type CreateVaultRequest = v.InferOutput<typeof CreateVaultRequest>;
-
-/** Response for creating a vault. */
-export const CreateVaultResponse = /* @__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("createVault"),
-            v.description("Type of response."),
-          ),
-          /** Vault address. */
-          data: v.pipe(
-            Address,
-            v.description("Vault address."),
-          ),
-        }),
-        v.description("Response details."),
-      ),
-    }),
-    v.description("Response for creating a vault."),
-  );
-})();
-export type CreateVaultResponse = v.InferOutput<typeof CreateVaultResponse>;
-
-// -------------------- Function --------------------
-
-/** Action parameters for the {@linkcode createVault} function. */
-export type CreateVaultParameters = ExtractRequestAction<v.InferInput<typeof CreateVaultRequest>>;
-/** Request options for the {@linkcode createVault} function. */
-export type CreateVaultOptions = ExtractRequestOptions<v.InferInput<typeof CreateVaultRequest>>;
-
-/**
- * Create a vault.
- * @param config - General configuration for Exchange API requests.
- * @param params - Parameters specific to the API request.
- * @param opts - Request execution options.
- * @returns Response for creating a vault.
- *
- * @throws {ApiRequestError} When the API returns an unsuccessful response.
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @see null
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { createVault } 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 createVault(
- *   { transport, wallet },
- *   {
- *     name: "...",
- *     description: "...",
- *     initialUsd: 100 * 1e6,
- *   },
- * );
- * ```
- */
-export async function createVault(
-  config: ExchangeRequestConfig | MultiSignRequestConfig,
-  params: DeepImmutable<CreateVaultParameters>,
-  opts?: CreateVaultOptions,
-): Promise<CreateVaultResponse> {
-  const request = parser(CreateVaultRequest)({
-    action: {
-      type: "createVault",
-      ...params,
-    },
-    nonce: 0, // Placeholder; actual nonce generated in `executeL1Action`
-    signature: { // Placeholder; actual signature generated in `executeL1Action`
-      r: "0x0000000000000000000000000000000000000000000000000000000000000000",
-      s: "0x0000000000000000000000000000000000000000000000000000000000000000",
-      v: 27,
-    },
-    expiresAfter: typeof config.defaultExpiresAfter === "number"
-      ? config.defaultExpiresAfter
-      : await config.defaultExpiresAfter?.(),
-  });
-  return await executeL1Action(config, request, opts?.signal);
-}

package/src/api/exchange/evmUserModify.ts

@@ -1,115 +0,0 @@
-import * as v from "valibot";
-import { type DeepImmutable, parser, UnsignedInteger } from "../_base.ts";
-import {
-  type ExchangeRequestConfig,
-  executeL1Action,
-  type ExtractRequestAction,
-  type ExtractRequestOptions,
-  type MultiSignRequestConfig,
-  Signature,
-} from "./_base/mod.ts";
-
-// -------------------- Schemas --------------------
-
-/**
- * Configure block type for EVM transactions.
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/hyperevm/dual-block-architecture
- */
-export const EvmUserModifyRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Action to perform. */
-      action: v.pipe(
-        v.object({
-          /** Type of action. */
-          type: v.pipe(
-            v.literal("evmUserModify"),
-            v.description("Type of action."),
-          ),
-          /** `true` for large blocks, `false` for small blocks. */
-          usingBigBlocks: v.pipe(
-            v.boolean(),
-            v.description("`true` for large blocks, `false` for small blocks."),
-          ),
-        }),
-        v.description("Action to perform."),
-      ),
-      /** Unique request identifier (current timestamp in ms). */
-      nonce: v.pipe(
-        UnsignedInteger,
-        v.description("Unique request identifier (current timestamp in ms)."),
-      ),
-      /** Cryptographic signature. */
-      signature: v.pipe(
-        Signature,
-        v.description("Cryptographic signature."),
-      ),
-      /** Expiration time of the action. */
-      expiresAfter: v.pipe(
-        v.optional(UnsignedInteger),
-        v.description("Expiration time of the action."),
-      ),
-    }),
-    v.description("Configure block type for EVM transactions."),
-  );
-})();
-export type EvmUserModifyRequest = v.InferOutput<typeof EvmUserModifyRequest>;
-
-import { SuccessResponse } from "./_base/mod.ts";
-export { SuccessResponse };
-
-// -------------------- Function --------------------
-
-/** Action parameters for the {@linkcode evmUserModify} function. */
-export type EvmUserModifyParameters = ExtractRequestAction<v.InferInput<typeof EvmUserModifyRequest>>;
-/** Request options for the {@linkcode evmUserModify} function. */
-export type EvmUserModifyOptions = ExtractRequestOptions<v.InferInput<typeof EvmUserModifyRequest>>;
-
-/**
- * Configure block type for EVM transactions.
- * @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 {ApiRequestError} When the API returns an unsuccessful response.
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/hyperevm/dual-block-architecture
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { evmUserModify } 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 evmUserModify(
- *   { transport, wallet },
- *   { usingBigBlocks: true },
- * );
- * ```
- */
-export async function evmUserModify(
-  config: ExchangeRequestConfig | MultiSignRequestConfig,
-  params: DeepImmutable<EvmUserModifyParameters>,
-  opts?: EvmUserModifyOptions,
-): Promise<SuccessResponse> {
-  const request = parser(EvmUserModifyRequest)({
-    action: {
-      type: "evmUserModify",
-      ...params,
-    },
-    nonce: 0, // Placeholder; actual nonce generated in `executeL1Action`
-    signature: { // Placeholder; actual signature generated in `executeL1Action`
-      r: "0x0000000000000000000000000000000000000000000000000000000000000000",
-      s: "0x0000000000000000000000000000000000000000000000000000000000000000",
-      v: 27,
-    },
-    expiresAfter: typeof config.defaultExpiresAfter === "number"
-      ? config.defaultExpiresAfter
-      : await config.defaultExpiresAfter?.(),
-  });
-  return await executeL1Action(config, request, opts?.signal);
-}

package/src/api/exchange/linkStakingUser.ts

@@ -1,157 +0,0 @@
-import * as v from "valibot";
-import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_base.ts";
-import {
-  type ExchangeRequestConfig,
-  executeUserSignedAction,
-  type ExtractRequestAction,
-  type ExtractRequestOptions,
-  getSignatureChainId,
-  type MultiSignRequestConfig,
-  Signature,
-} from "./_base/mod.ts";
-
-// -------------------- Schemas --------------------
-
-/**
- * Link staking and trading accounts for fee discount attribution.
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/fees#staking-linking
- */
-export const LinkStakingUserRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Action to perform. */
-      action: v.pipe(
-        v.object({
-          /** Type of action. */
-          type: v.pipe(
-            v.literal("linkStakingUser"),
-            v.description("Type of action."),
-          ),
-          /** Chain ID used for signing. */
-          signatureChainId: v.pipe(
-            Hex,
-            v.description("Chain ID used for signing."),
-          ),
-          /** HyperLiquid network. */
-          hyperliquidChain: v.pipe(
-            v.union([v.literal("Mainnet"), v.literal("Testnet")]),
-            v.description("HyperLiquid network."),
-          ),
-          /**
-           * Target account address.
-           * - Trading user initiating: enter staking account address.
-           * - Staking user finalizing: enter trading account address.
-           */
-          user: v.pipe(
-            Address,
-            v.description(
-              "Target account address." +
-                "\n- Trading user initiating: enter staking account address." +
-                "\n- Staking user finalizing: enter trading account address.",
-            ),
-          ),
-          /**
-           * Link phase.
-           * - `false` = trading user initiates link request.
-           * - `true` = staking user finalizes permanent link.
-           */
-          isFinalize: v.pipe(
-            v.boolean(),
-            v.description(
-              "Link phase." +
-                "\n- `false` = trading user initiates link request." +
-                "\n- `true` = staking user finalizes permanent link.",
-            ),
-          ),
-          /** Unique request identifier (current timestamp in ms). */
-          nonce: v.pipe(
-            UnsignedInteger,
-            v.description("Unique request identifier (current timestamp in ms)."),
-          ),
-        }),
-        v.description("Action to perform."),
-      ),
-      /** Unique request identifier (current timestamp in ms). */
-      nonce: v.pipe(
-        UnsignedInteger,
-        v.description("Unique request identifier (current timestamp in ms)."),
-      ),
-      /** Cryptographic signature. */
-      signature: v.pipe(
-        Signature,
-        v.description("Cryptographic signature."),
-      ),
-    }),
-    v.description(""),
-  );
-})();
-export type LinkStakingUserRequest = v.InferOutput<typeof LinkStakingUserRequest>;
-
-import { SuccessResponse } from "./_base/mod.ts";
-export { SuccessResponse };
-
-// -------------------- Function --------------------
-
-/** Action parameters for the {@linkcode linkStakingUser} function. */
-export type LinkStakingUserParameters = ExtractRequestAction<v.InferInput<typeof LinkStakingUserRequest>>;
-/** Request options for the {@linkcode linkStakingUser} function. */
-export type LinkStakingUserOptions = ExtractRequestOptions<v.InferInput<typeof LinkStakingUserRequest>>;
-
-/** EIP-712 types for the {@linkcode linkStakingUser} function. */
-export const LinkStakingUserTypes = {
-  "HyperliquidTransaction:LinkStakingUser": [
-    { name: "hyperliquidChain", type: "string" },
-    { name: "user", type: "address" },
-    { name: "isFinalize", type: "bool" },
-    { name: "nonce", type: "uint64" },
-  ],
-};
-
-/**
- * Link staking and trading accounts for fee discount attribution.
- * @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 {ApiRequestError} When the API returns an unsuccessful response.
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/fees#staking-linking
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { linkStakingUser } 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 linkStakingUser(
- *   { transport, wallet },
- *   { user: "0x...", isFinalize: false },
- * );
- * ```
- */
-export async function linkStakingUser(
-  config: ExchangeRequestConfig | MultiSignRequestConfig,
-  params: DeepImmutable<LinkStakingUserParameters>,
-  opts?: LinkStakingUserOptions,
-): Promise<SuccessResponse> {
-  const request = parser(LinkStakingUserRequest)({
-    action: {
-      type: "linkStakingUser",
-      hyperliquidChain: config.transport.isTestnet ? "Testnet" : "Mainnet",
-      signatureChainId: await getSignatureChainId(config),
-      nonce: 0, // Placeholder; actual nonce generated in `executeUserSignedAction` to prevent race conditions
-      ...params,
-    },
-    nonce: 0, // Placeholder; actual nonce generated in `executeUserSignedAction` to prevent race conditions
-    signature: { // Placeholder; actual signature generated in `executeUserSignedAction`
-      r: "0x0000000000000000000000000000000000000000000000000000000000000000",
-      s: "0x0000000000000000000000000000000000000000000000000000000000000000",
-      v: 27,
-    },
-  });
-  return await executeUserSignedAction(config, request, LinkStakingUserTypes, opts?.signal);
-}