@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.1

package/src/src/api/exchange/evmUserModify.ts

@@ -0,0 +1,107 @@
+import { type DeepImmutable, parser, UnsignedInteger } from "../_common.js";
+import {
+  type ExchangeRequestConfig,
+  executeL1Action,
+  type ExtractRequestAction,
+  type ExtractRequestOptions,
+  type MultiSignRequestConfig,
+  Signature,
+} from "./_common.js";
+import * as v from "valibot";
+
+// -------------------- 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 "./_common.js";
+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 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 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 action = parser(EvmUserModifyRequest.entries.action)({
+    type: "evmUserModify",
+    ...params,
+  });
+  const expiresAfter = typeof config.defaultExpiresAfter === "number"
+    ? config.defaultExpiresAfter
+    : await config.defaultExpiresAfter?.();
+  return await executeL1Action(config, { action, expiresAfter }, opts?.signal);
+}

package/src/src/api/exchange/modify.ts

@@ -0,0 +1,225 @@
+import { Address, type DeepImmutable, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+import {
+  type ExchangeRequestConfig,
+  executeL1Action,
+  type ExtractRequestAction,
+  type ExtractRequestOptions,
+  type MultiSignRequestConfig,
+  Signature,
+} from "./_common.js";
+import * as v from "valibot";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Modify an order.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-an-order
+ */
+export const ModifyRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Action to perform. */
+      action: v.pipe(
+        v.object({
+          /** Type of action. */
+          type: v.pipe(
+            v.literal("modify"),
+            v.description("Type of action."),
+          ),
+          /** Order ID or Client Order ID. */
+          oid: v.pipe(
+            v.union([
+              UnsignedInteger,
+              v.pipe(Hex, v.length(34)),
+            ]),
+            v.description("Order ID or Client Order ID."),
+          ),
+          /** New order parameters. */
+          order: v.pipe(
+            v.object({
+              /** Asset ID. */
+              a: v.pipe(
+                UnsignedInteger,
+                v.description("Asset ID."),
+              ),
+              /** Position side (`true` for long, `false` for short). */
+              b: v.pipe(
+                v.boolean(),
+                v.description("Position side (`true` for long, `false` for short)."),
+              ),
+              /** Price. */
+              p: v.pipe(
+                UnsignedDecimal,
+                v.description("Price."),
+              ),
+              /** Size (in base currency units). */
+              s: v.pipe(
+                UnsignedDecimal,
+                v.description("Size (in base currency units)."),
+              ),
+              /** Is reduce-only? */
+              r: v.pipe(
+                v.boolean(),
+                v.description("Is reduce-only?"),
+              ),
+              /** Order type. */
+              t: v.pipe(
+                v.union([
+                  v.object({
+                    /** Limit order parameters. */
+                    limit: v.pipe(
+                      v.object({
+                        /**
+                         * Time-in-force.
+                         * - `"Gtc"`: Remains active until filled or canceled.
+                         * - `"Ioc"`: Fills immediately or cancels any unfilled portion.
+                         * - `"Alo"`: Adds liquidity only.
+                         * - `"FrontendMarket"`: Similar to Ioc, used in Hyperliquid UI.
+                         * - `"LiquidationMarket"`: Similar to Ioc, used in Hyperliquid UI.
+                         */
+                        tif: v.pipe(
+                          v.union([
+                            v.literal("Gtc"),
+                            v.literal("Ioc"),
+                            v.literal("Alo"),
+                            v.literal("FrontendMarket"),
+                            v.literal("LiquidationMarket"),
+                          ]),
+                          v.description(
+                            "Time-in-force." +
+                              '\n- `"Gtc"`: Remains active until filled or canceled.' +
+                              '\n- `"Ioc"`: Fills immediately or cancels any unfilled portion.' +
+                              '\n- `"Alo"`: Adds liquidity only.' +
+                              '\n- `"FrontendMarket"`: Similar to Ioc, used in Hyperliquid UI.' +
+                              '\n- `"LiquidationMarket"`: Similar to Ioc, used in Hyperliquid UI.',
+                          ),
+                        ),
+                      }),
+                      v.description("Limit order parameters."),
+                    ),
+                  }),
+                  v.object({
+                    /** Trigger order parameters. */
+                    trigger: v.pipe(
+                      v.object({
+                        /** Is market order? */
+                        isMarket: v.pipe(
+                          v.boolean(),
+                          v.description("Is market order?"),
+                        ),
+                        /** Trigger price. */
+                        triggerPx: v.pipe(
+                          UnsignedDecimal,
+                          v.description("Trigger price."),
+                        ),
+                        /** Indicates whether it is take profit or stop loss. */
+                        tpsl: v.pipe(
+                          v.union([v.literal("tp"), v.literal("sl")]),
+                          v.description("Indicates whether it is take profit or stop loss."),
+                        ),
+                      }),
+                      v.description("Trigger order parameters."),
+                    ),
+                  }),
+                ]),
+                v.description("Order type."),
+              ),
+              /** Client Order ID. */
+              c: v.pipe(
+                v.optional(v.pipe(Hex, v.length(34))),
+                v.description("Client Order ID."),
+              ),
+            }),
+            v.description("New order parameters."),
+          ),
+        }),
+        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."),
+      ),
+      /** 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("Modify an order."),
+  );
+})();
+export type ModifyRequest = v.InferOutput<typeof ModifyRequest>;
+
+import { SuccessResponse } from "./_common.js";
+export { SuccessResponse };
+
+// -------------------- Function --------------------
+
+/** Action parameters for the {@linkcode modify} function. */
+export type ModifyParameters = ExtractRequestAction<v.InferInput<typeof ModifyRequest>>;
+/** Request options for the {@linkcode modify} function. */
+export type ModifyOptions = ExtractRequestOptions<v.InferInput<typeof ModifyRequest>>;
+
+/**
+ * Modify an order.
+ * @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/exchange-endpoint#modify-an-order
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { modify } 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 modify(
+ *   { transport, wallet },
+ *   {
+ *     oid: 123,
+ *     order: {
+ *       a: 0,
+ *       b: true,
+ *       p: "31000",
+ *       s: "0.2",
+ *       r: false,
+ *       t: { limit: { tif: "Gtc" } },
+ *       c: "0x...",
+ *     },
+ *   },
+ * );
+ * ```
+ */
+export async function modify(
+  config: ExchangeRequestConfig | MultiSignRequestConfig,
+  params: DeepImmutable<ModifyParameters>,
+  opts?: ModifyOptions,
+): Promise<SuccessResponse> {
+  const action = parser(ModifyRequest.entries.action)({
+    type: "modify",
+    ...params,
+  });
+  const vaultAddress = opts?.vaultAddress ?? config.defaultVaultAddress;
+  const expiresAfter = typeof config.defaultExpiresAfter === "number"
+    ? config.defaultExpiresAfter
+    : await config.defaultExpiresAfter?.();
+  return await executeL1Action(config, { action, vaultAddress, expiresAfter }, opts?.signal);
+}

package/src/src/api/exchange/multiSig.ts

@@ -0,0 +1,304 @@
+import { Address, type DeepImmutable, Hex, parser, UnsignedInteger } from "../_common.js";
+import {
+  type ExchangeRequestConfig,
+  executeMultiSigAction,
+  type ExtractRequestAction,
+  type ExtractRequestOptions,
+  getSignatureChainId,
+  Signature,
+} from "./_common.js";
+import * as v from "valibot";
+
+// -------------------- Schemas --------------------
+
+import { ApproveAgentRequest } from "./approveAgent.js";
+import { ApproveBuilderFeeRequest } from "./approveBuilderFee.js";
+import { BatchModifyRequest } from "./batchModify.js";
+import { CancelRequest, CancelSuccessResponse } from "./cancel.js";
+import { CancelByCloidRequest } from "./cancelByCloid.js";
+import { ClaimRewardsRequest } from "./claimRewards.js";
+import { CDepositRequest } from "./cDeposit.js";
+import { ConvertToMultiSigUserRequest } from "./convertToMultiSigUser.js";
+import { CreateSubAccountRequest, CreateSubAccountResponse } from "./createSubAccount.js";
+import { CreateVaultRequest, CreateVaultResponse } from "./createVault.js";
+import { CSignerActionRequest } from "./cSignerAction.js";
+import { CValidatorActionRequest } from "./cValidatorAction.js";
+import { CWithdrawRequest } from "./cWithdraw.js";
+import { EvmUserModifyRequest } from "./evmUserModify.js";
+import { ModifyRequest } from "./modify.js";
+import { NoopRequest } from "./noop.js";
+import { OrderRequest, OrderSuccessResponse } from "./order.js";
+import { RegisterReferrerRequest } from "./registerReferrer.js";
+import { ReserveRequestWeightRequest } from "./reserveRequestWeight.js";
+import { ScheduleCancelRequest } from "./scheduleCancel.js";
+import { SetDisplayNameRequest } from "./setDisplayName.js";
+import { SetReferrerRequest } from "./setReferrer.js";
+import { SpotDeployRequest } from "./spotDeploy.js";
+import { SubAccountModifyRequest } from "./subAccountModify.js";
+import { TokenDelegateRequest } from "./tokenDelegate.js";
+import { TwapOrderRequest, TwapOrderSuccessResponse } from "./twapOrder.js";
+import { UsdClassTransferRequest } from "./usdClassTransfer.js";
+import { VaultDistributeRequest } from "./vaultDistribute.js";
+import { Withdraw3Request } from "./withdraw3.js";
+import { PerpDeployRequest } from "./perpDeploy.js";
+import { SendAssetRequest } from "./sendAsset.js";
+import { SpotSendRequest } from "./spotSend.js";
+import { SpotUserRequest } from "./spotUser.js";
+import { SubAccountSpotTransferRequest } from "./subAccountSpotTransfer.js";
+import { SubAccountTransferRequest } from "./subAccountTransfer.js";
+import { TwapCancelRequest, TwapCancelSuccessResponse } from "./twapCancel.js";
+import { UpdateIsolatedMarginRequest } from "./updateIsolatedMargin.js";
+import { UpdateLeverageRequest } from "./updateLeverage.js";
+import { UsdSendRequest } from "./usdSend.js";
+import { VaultModifyRequest } from "./vaultModify.js";
+import { VaultTransferRequest } from "./vaultTransfer.js";
+
+/**
+ * A multi-signature request.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/hypercore/multi-sig
+ */
+export const MultiSigRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Action to perform. */
+      action: v.pipe(
+        v.object({
+          /** Type of action. */
+          type: v.pipe(
+            v.literal("multiSig"),
+            v.description("Type of action."),
+          ),
+          /** Chain ID used for signing. */
+          signatureChainId: v.pipe(
+            Hex,
+            v.description("Chain ID used for signing."),
+          ),
+          /** List of signatures from authorized signers. */
+          signatures: v.pipe(
+            v.array(Signature),
+            v.description("List of signatures from authorized signers."),
+          ),
+          /** Multi-signature payload information. */
+          payload: v.pipe(
+            v.object({
+              /** Address of the multi-signature user account. */
+              multiSigUser: v.pipe(
+                Address,
+                v.description("Address of the multi-signature user account."),
+              ),
+              /** Address of the authorized user initiating the request (any authorized user). */
+              outerSigner: v.pipe(
+                Address,
+                v.description(
+                  "Address of the authorized user initiating the request (any authorized user).",
+                ),
+              ),
+              /** The underlying action to be executed through multi-sig. */
+              action: v.pipe(
+                v.union([
+                  ApproveAgentRequest.entries.action,
+                  ApproveBuilderFeeRequest.entries.action,
+                  BatchModifyRequest.entries.action,
+                  CancelRequest.entries.action,
+                  CancelByCloidRequest.entries.action,
+                  CDepositRequest.entries.action,
+                  ClaimRewardsRequest.entries.action,
+                  ConvertToMultiSigUserRequest.entries.action,
+                  CreateSubAccountRequest.entries.action,
+                  CreateVaultRequest.entries.action,
+                  CSignerActionRequest.entries.action,
+                  CValidatorActionRequest.entries.action,
+                  CWithdrawRequest.entries.action,
+                  EvmUserModifyRequest.entries.action,
+                  ModifyRequest.entries.action,
+                  NoopRequest.entries.action,
+                  OrderRequest.entries.action,
+                  PerpDeployRequest.entries.action,
+                  RegisterReferrerRequest.entries.action,
+                  ReserveRequestWeightRequest.entries.action,
+                  ScheduleCancelRequest.entries.action,
+                  SendAssetRequest.entries.action,
+                  SetDisplayNameRequest.entries.action,
+                  SetReferrerRequest.entries.action,
+                  SpotDeployRequest.entries.action,
+                  SpotSendRequest.entries.action,
+                  SpotUserRequest.entries.action,
+                  SubAccountModifyRequest.entries.action,
+                  SubAccountSpotTransferRequest.entries.action,
+                  SubAccountTransferRequest.entries.action,
+                  TokenDelegateRequest.entries.action,
+                  TwapCancelRequest.entries.action,
+                  TwapOrderRequest.entries.action,
+                  UpdateIsolatedMarginRequest.entries.action,
+                  UpdateLeverageRequest.entries.action,
+                  UsdClassTransferRequest.entries.action,
+                  UsdSendRequest.entries.action,
+                  VaultDistributeRequest.entries.action,
+                  VaultModifyRequest.entries.action,
+                  VaultTransferRequest.entries.action,
+                  Withdraw3Request.entries.action,
+                ]),
+                v.description("The underlying action to be executed through multi-sig."),
+              ),
+            }),
+            v.description("Multi-signature payload information."),
+          ),
+        }),
+        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."),
+      ),
+      /** 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("A multi-signature request."),
+  );
+})();
+export type MultiSigRequest = v.InferOutput<typeof MultiSigRequest>;
+
+import { SuccessResponse } from "./_common.js";
+export {
+  CancelSuccessResponse,
+  CreateSubAccountResponse,
+  CreateVaultResponse,
+  OrderSuccessResponse,
+  SuccessResponse,
+  TwapCancelSuccessResponse,
+  TwapOrderSuccessResponse,
+};
+
+// -------------------- Function --------------------
+
+/** Action parameters for the {@linkcode multiSig} function. */
+export type MultiSigParameters =
+  & ExtractRequestAction<v.InferInput<typeof MultiSigRequest>>
+  & Pick<v.InferInput<typeof MultiSigRequest>, "nonce">;
+/** Request options for the {@linkcode multiSig} function. */
+export type MultiSigOptions = ExtractRequestOptions<v.InferInput<typeof MultiSigRequest>>;
+
+/** EIP-712 types for the {@linkcode multiSig} function. */
+export const MultiSigTypes = {
+  "HyperliquidTransaction:SendMultiSig": [
+    { name: "hyperliquidChain", type: "string" },
+    { name: "multiSigActionHash", type: "bytes32" },
+    { name: "nonce", type: "uint64" },
+  ],
+};
+
+/**
+ * A multi-signature request.
+ * @param config - General configuration for Exchange API requests.
+ * @param params - Parameters specific to the API request.
+ * @param opts - Request execution options.
+ * @returns Any successful response.
+ *
+ * @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/hypercore/multi-sig
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { multiSig, parser, ScheduleCancelRequest } from "@nktkas/hyperliquid/api/exchange";
+ * import { signL1Action } from "@nktkas/hyperliquid/signing";
+ * import { privateKeyToAccount } from "npm:viem/accounts";
+ *
+ * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+ * const multiSigUser = "0x...";
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * const nonce = Date.now();
+ * const action = parser(ScheduleCancelRequest.entries.action)({
+ *   type: "scheduleCancel",
+ *   time: Date.now() + 10000,
+ * });
+ *
+ * // Create the required number of signatures
+ * const signatures = await Promise.all(["0x...", "0x..."].map(async (signerPrivKey) => {
+ *   return await signL1Action({
+ *     wallet: privateKeyToAccount(signerPrivKey as `0x${string}`), // viem or ethers
+ *     action: [multiSigUser.toLowerCase(), wallet.address.toLowerCase(), action],
+ *     nonce,
+ *   });
+ * }));
+ *
+ * // // or user-signed action
+ * // const signatures = await Promise.all(["0x...", "0x..."].map(async (signerPrivKey) => {
+ * //   return await signUserSignedAction({
+ * //     wallet: privateKeyToAccount(signerPrivKey as `0x${string}`), // viem or ethers
+ * //     action: {
+ * //       ...action,
+ * //       payloadMultiSigUser: multiSigUser,
+ * //       outerSigner: wallet.address,
+ * //     },
+ * //     types: SomeTypes,
+ * //   });
+ * // }));
+ *
+ * // Then use signatures in the `multiSig` action
+ * const data = await multiSig(
+ *   { transport, wallet },
+ *   {
+ *     signatures,
+ *     payload: {
+ *       multiSigUser,
+ *       outerSigner: wallet.address,
+ *       action,
+ *     },
+ *     nonce,
+ *   },
+ * );
+ * ```
+ */
+export async function multiSig<
+  T extends
+    | SuccessResponse
+    | CancelSuccessResponse
+    | CreateSubAccountResponse
+    | CreateVaultResponse
+    | OrderSuccessResponse
+    | TwapOrderSuccessResponse
+    | TwapCancelSuccessResponse,
+>(
+  config: ExchangeRequestConfig,
+  paramsAndNonce: DeepImmutable<MultiSigParameters>,
+  opts?: MultiSigOptions,
+): Promise<T> {
+  const { nonce, ...params } = paramsAndNonce;
+
+  const action = parser(MultiSigRequest.entries.action)({
+    type: "multiSig",
+    signatureChainId: await getSignatureChainId(config),
+    ...params,
+  });
+  const vaultAddress = opts?.vaultAddress ?? config.defaultVaultAddress;
+  const expiresAfter = typeof config.defaultExpiresAfter === "number"
+    ? config.defaultExpiresAfter
+    : await config.defaultExpiresAfter?.();
+  return await executeMultiSigAction(
+    config,
+    {
+      action,
+      vaultAddress,
+      expiresAfter,
+      nonce: Number(nonce),
+    },
+    opts?.signal,
+  );
+}