@hfunlabs/hyperliquid 0.27.1-hfunlabs.5 → 0.29.1-hfunlabs.1

package/src/src/api/exchange/setDisplayName.ts

@@ -1,136 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { UnsignedInteger } from "../_base.js";
-import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.js";
-
-/** Set the display name in the leaderboard. */
-export const SetDisplayNameRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Action to perform. */
-      action: v.pipe(
-        v.object({
-          /** Type of action. */
-          type: v.pipe(
-            v.literal("setDisplayName"),
-            v.description("Type of action."),
-          ),
-          /**
-           * Display name.
-           *
-           * Set to an empty string to remove the display name.
-           */
-          displayName: v.pipe(
-            v.string(),
-            v.description(
-              "Display name." +
-                "\n\nSet to an empty string to remove the display 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("Set the display name in the leaderboard."),
-  );
-})();
-export type SetDisplayNameRequest = v.InferOutput<typeof SetDisplayNameRequest>;
-
-/** Successful response without specific data or error response. */
-export const SetDisplayNameResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.union([SuccessResponse, ErrorResponse]),
-    v.description("Successful response without specific data or error response."),
-  );
-})();
-export type SetDisplayNameResponse = v.InferOutput<typeof SetDisplayNameResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import { type DeepImmutable, parser } from "../_base.js";
-import {
-  type ExchangeRequestConfig,
-  type ExcludeErrorResponse,
-  executeL1Action,
-  type ExtractRequestAction,
-  type ExtractRequestOptions,
-  type MultiSignRequestConfig,
-} from "./_base/mod.js";
-
-/** Action parameters for the {@linkcode setDisplayName} function. */
-export type SetDisplayNameParameters = ExtractRequestAction<v.InferInput<typeof SetDisplayNameRequest>>;
-
-/** Request options for the {@linkcode setDisplayName} function. */
-export type SetDisplayNameOptions = ExtractRequestOptions<v.InferInput<typeof SetDisplayNameRequest>>;
-
-/** Successful variant of {@linkcode SetDisplayNameResponse} without errors. */
-export type SetDisplayNameSuccessResponse = ExcludeErrorResponse<SetDisplayNameResponse>;
-
-/**
- * Set the display name in the leaderboard.
- * @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.
- *
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { setDisplayName } 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 setDisplayName(
- *   { transport, wallet },
- *   { displayName: "..." },
- * );
- * ```
- */
-export async function setDisplayName(
-  config: ExchangeRequestConfig | MultiSignRequestConfig,
-  params: DeepImmutable<SetDisplayNameParameters>,
-  opts?: SetDisplayNameOptions,
-): Promise<SetDisplayNameSuccessResponse> {
-  const request = parser(SetDisplayNameRequest)({
-    action: {
-      type: "setDisplayName",
-      ...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/src/api/exchange/setReferrer.ts

@@ -1,130 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { UnsignedInteger } from "../_base.js";
-import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.js";
-
-/** Set a referral code. */
-export const SetReferrerRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Action to perform. */
-      action: v.pipe(
-        v.object({
-          /** Type of action. */
-          type: v.pipe(
-            v.literal("setReferrer"),
-            v.description("Type of action."),
-          ),
-          /** Referral code. */
-          code: v.pipe(
-            v.string(),
-            v.minLength(1),
-            v.description("Referral code."),
-          ),
-        }),
-        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("Set a referral code."),
-  );
-})();
-export type SetReferrerRequest = v.InferOutput<typeof SetReferrerRequest>;
-
-/** Successful response without specific data or error response. */
-export const SetReferrerResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.union([SuccessResponse, ErrorResponse]),
-    v.description("Successful response without specific data or error response."),
-  );
-})();
-export type SetReferrerResponse = v.InferOutput<typeof SetReferrerResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import { type DeepImmutable, parser } from "../_base.js";
-import {
-  type ExchangeRequestConfig,
-  type ExcludeErrorResponse,
-  executeL1Action,
-  type ExtractRequestAction,
-  type ExtractRequestOptions,
-  type MultiSignRequestConfig,
-} from "./_base/mod.js";
-
-/** Action parameters for the {@linkcode setReferrer} function. */
-export type SetReferrerParameters = ExtractRequestAction<v.InferInput<typeof SetReferrerRequest>>;
-
-/** Request options for the {@linkcode setReferrer} function. */
-export type SetReferrerOptions = ExtractRequestOptions<v.InferInput<typeof SetReferrerRequest>>;
-
-/** Successful variant of {@linkcode SetReferrerResponse} without errors. */
-export type SetReferrerSuccessResponse = ExcludeErrorResponse<SetReferrerResponse>;
-
-/**
- * Set a referral code.
- * @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.
- *
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { setReferrer } 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 setReferrer(
- *   { transport, wallet },
- *   { code: "..." },
- * );
- * ```
- */
-export async function setReferrer(
-  config: ExchangeRequestConfig | MultiSignRequestConfig,
-  params: DeepImmutable<SetReferrerParameters>,
-  opts?: SetReferrerOptions,
-): Promise<SetReferrerSuccessResponse> {
-  const request = parser(SetReferrerRequest)({
-    action: {
-      type: "setReferrer",
-      ...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/src/api/exchange/spotDeploy.ts

@@ -1,379 +0,0 @@
-import * as v from "valibot";
-
-// ============================================================
-// API Schemas
-// ============================================================
-
-import { Address, Percent, UnsignedDecimal, UnsignedInteger } from "../_base.js";
-import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.js";
-
-/**
- * Deploying HIP-1 and HIP-2 assets.
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/deploying-hip-1-and-hip-2-assets
- */
-export const SpotDeployRequest = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.object({
-      /** Action to perform. */
-      action: v.pipe(
-        v.union([
-          v.pipe(
-            v.object({
-              /** Type of action. */
-              type: v.pipe(
-                v.literal("spotDeploy"),
-                v.description("Type of action."),
-              ),
-              /** Genesis parameters. */
-              genesis: v.pipe(
-                v.object({
-                  /** Token identifier. */
-                  token: v.pipe(
-                    UnsignedInteger,
-                    v.description("Token identifier."),
-                  ),
-                  /** Maximum token supply. */
-                  maxSupply: v.pipe(
-                    UnsignedDecimal,
-                    v.description("Maximum token supply."),
-                  ),
-                  /** Set hyperliquidity balance to 0. */
-                  noHyperliquidity: v.pipe(
-                    v.optional(v.literal(true)),
-                    v.description("Set hyperliquidity balance to 0."),
-                  ),
-                }),
-                v.description("Genesis parameters."),
-              ),
-            }),
-            v.description("Genesis variant"),
-          ),
-          v.pipe(
-            v.object({
-              /** Type of action. */
-              type: v.pipe(
-                v.literal("spotDeploy"),
-                v.description("Type of action."),
-              ),
-              /** Register hyperliquidity parameters. */
-              registerHyperliquidity: v.pipe(
-                v.object({
-                  /** Spot index (distinct from base token index). */
-                  spot: v.pipe(
-                    UnsignedInteger,
-                    v.description("Spot index (distinct from base token index)."),
-                  ),
-                  /** Starting price for liquidity seeding. */
-                  startPx: v.pipe(
-                    UnsignedDecimal,
-                    v.description("Starting price for liquidity seeding."),
-                  ),
-                  /** Order size as a float (not in wei). */
-                  orderSz: v.pipe(
-                    UnsignedDecimal,
-                    v.description("Order size as a float (not in wei)."),
-                  ),
-                  /** Total number of orders to place. */
-                  nOrders: v.pipe(
-                    UnsignedInteger,
-                    v.description("Total number of orders to place."),
-                  ),
-                  /** Number of levels to seed with USDC. */
-                  nSeededLevels: v.pipe(
-                    v.optional(UnsignedInteger),
-                    v.description("Number of levels to seed with USDC."),
-                  ),
-                }),
-                v.description("Register hyperliquidity parameters."),
-              ),
-            }),
-            v.description("Register hyperliquidity variant"),
-          ),
-          v.pipe(
-            v.object({
-              /** Type of action. */
-              type: v.pipe(
-                v.literal("spotDeploy"),
-                v.description("Type of action."),
-              ),
-              /** Register spot parameters. */
-              registerSpot: v.pipe(
-                v.object({
-                  /** Tuple containing base and quote token indices. */
-                  tokens: v.pipe(
-                    v.tuple([
-                      UnsignedInteger,
-                      UnsignedInteger,
-                    ]),
-                    v.description("Tuple containing base and quote token indices."),
-                  ),
-                }),
-                v.description("Register spot parameters."),
-              ),
-            }),
-            v.description("Register spot variant"),
-          ),
-          v.pipe(
-            v.object({
-              /** Type of action. */
-              type: v.pipe(
-                v.literal("spotDeploy"),
-                v.description("Type of action."),
-              ),
-              /** Register token parameters. */
-              registerToken2: v.pipe(
-                v.object({
-                  /** Token specifications. */
-                  spec: v.pipe(
-                    v.object({
-                      /** Token name. */
-                      name: v.pipe(
-                        v.string(),
-                        v.description("Token name."),
-                      ),
-                      /** Number of decimals for token size. */
-                      szDecimals: v.pipe(
-                        UnsignedInteger,
-                        v.description("Number of decimals for token size."),
-                      ),
-                      /** Number of decimals for token amounts in wei. */
-                      weiDecimals: v.pipe(
-                        UnsignedInteger,
-                        v.description("Number of decimals for token amounts in wei."),
-                      ),
-                    }),
-                    v.description("Token specifications."),
-                  ),
-                  /** Maximum gas allowed for registration. */
-                  maxGas: v.pipe(
-                    UnsignedInteger,
-                    v.description("Maximum gas allowed for registration."),
-                  ),
-                  /** Optional full token name. */
-                  fullName: v.pipe(
-                    v.optional(v.string()),
-                    v.description("Optional full token name."),
-                  ),
-                }),
-                v.description("Register token parameters."),
-              ),
-            }),
-            v.description("Register token variant"),
-          ),
-          v.pipe(
-            v.object({
-              /** Type of action. */
-              type: v.pipe(
-                v.literal("spotDeploy"),
-                v.description("Type of action."),
-              ),
-              /** Set deployer trading fee share parameters. */
-              setDeployerTradingFeeShare: v.pipe(
-                v.object({
-                  /** Token identifier. */
-                  token: v.pipe(
-                    UnsignedInteger,
-                    v.description("Token identifier."),
-                  ),
-                  /** The deployer trading fee share. Range is 0% to 100%. */
-                  share: v.pipe(
-                    Percent,
-                    v.description("The deployer trading fee share. Range is 0% to 100%."),
-                  ),
-                }),
-                v.description("Set deployer trading fee share parameters."),
-              ),
-            }),
-            v.description("Set deployer trading fee share variant"),
-          ),
-          v.pipe(
-            v.object({
-              /** Type of action. */
-              type: v.pipe(
-                v.literal("spotDeploy"),
-                v.description("Type of action."),
-              ),
-              /** User genesis parameters. */
-              userGenesis: v.pipe(
-                v.object({
-                  /** Token identifier. */
-                  token: v.pipe(
-                    UnsignedInteger,
-                    v.description("Token identifier."),
-                  ),
-                  /** Array of tuples: [user address, genesis amount in wei]. */
-                  userAndWei: v.pipe(
-                    v.array(v.tuple([Address, UnsignedDecimal])),
-                    v.description("Array of tuples: [user address, genesis amount in wei]."),
-                  ),
-                  /** Array of tuples: [existing token identifier, genesis amount in wei]. */
-                  existingTokenAndWei: v.pipe(
-                    v.array(
-                      v.tuple([
-                        UnsignedInteger,
-                        UnsignedDecimal,
-                      ]),
-                    ),
-                    v.description(
-                      "Array of tuples: [existing token identifier, genesis amount in wei].",
-                    ),
-                  ),
-                  /** Array of tuples: [user address, blacklist status] (`true` for blacklist, `false` to remove existing blacklisted user). */
-                  blacklistUsers: v.pipe(
-                    v.optional(v.array(v.tuple([Address, v.boolean()]))),
-                    v.description(
-                      "Array of tuples: [user address, blacklist status] (`true` for blacklist, `false` to remove existing blacklisted user).",
-                    ),
-                  ),
-                }),
-                v.description("User genesis parameters."),
-              ),
-            }),
-            v.description("User genesis variant"),
-          ),
-          v.pipe(
-            v.object({
-              /** Type of action. */
-              type: v.pipe(
-                v.literal("spotDeploy"),
-                v.description("Type of action."),
-              ),
-              /** Enable quote token parameters. */
-              enableQuoteToken: v.pipe(
-                v.object({
-                  /** The token ID to convert to a quote token. */
-                  token: v.pipe(
-                    UnsignedInteger,
-                    v.description("The token ID to convert to a quote token."),
-                  ),
-                }),
-                v.description("Enable quote token parameters."),
-              ),
-            }),
-            v.description("Convert token to quote token variant"),
-          ),
-        ]),
-        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(
-      "Deploying HIP-1 and HIP-2 assets:" +
-        "\n- Genesis" +
-        "\n- Register Hyperliquidity" +
-        "\n- Register Spot" +
-        "\n- Register Token2" +
-        "\n- Set Deployer Trading Fee Share" +
-        "\n- User Genesis",
-    ),
-  );
-})();
-export type SpotDeployRequest = v.InferOutput<typeof SpotDeployRequest>;
-
-/**
- * Successful response without specific data or error response.
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/deploying-hip-1-and-hip-2-assets
- */
-export const SpotDeployResponse = /* @__PURE__ */ (() => {
-  return v.pipe(
-    v.union([SuccessResponse, ErrorResponse]),
-    v.description("Successful response without specific data or error response."),
-  );
-})();
-export type SpotDeployResponse = v.InferOutput<typeof SpotDeployResponse>;
-
-// ============================================================
-// Execution Logic
-// ============================================================
-
-import { type DeepImmutable, parser } from "../_base.js";
-import {
-  type ExchangeRequestConfig,
-  type ExcludeErrorResponse,
-  executeL1Action,
-  type ExtractRequestAction,
-  type ExtractRequestOptions,
-  type MultiSignRequestConfig,
-} from "./_base/mod.js";
-
-/** Action parameters for the {@linkcode spotDeploy} function. */
-export type SpotDeployParameters = ExtractRequestAction<v.InferInput<typeof SpotDeployRequest>>;
-
-/** Request options for the {@linkcode spotDeploy} function. */
-export type SpotDeployOptions = ExtractRequestOptions<v.InferInput<typeof SpotDeployRequest>>;
-
-/** Successful variant of {@linkcode SpotDeployResponse} without errors. */
-export type SpotDeploySuccessResponse = ExcludeErrorResponse<SpotDeployResponse>;
-
-/**
- * Deploying HIP-1 and HIP-2 assets.
- * @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/api/deploying-hip-1-and-hip-2-assets
- * @example
- * ```ts
- * import { HttpTransport } from "@nktkas/hyperliquid";
- * import { spotDeploy } 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 spotDeploy(
- *   { transport, wallet },
- *   {
- *     registerToken2: {
- *       spec: {
- *         name: "USDC",
- *         szDecimals: 8,
- *         weiDecimals: 8,
- *       },
- *       maxGas: 1000000,
- *       fullName: "USD Coin",
- *     },
- *   },
- * );
- * ```
- */
-export async function spotDeploy(
-  config: ExchangeRequestConfig | MultiSignRequestConfig,
-  params: DeepImmutable<SpotDeployParameters>,
-  opts?: SpotDeployOptions,
-): Promise<SpotDeploySuccessResponse> {
-  const request = parser(SpotDeployRequest)({
-    action: {
-      type: "spotDeploy",
-      ...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);
-}