@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.1

package/esm/src/api/exchange/createSubAccount.js

@@ -0,0 +1,76 @@
+import { Address, parser, UnsignedInteger } from "../_common.js";
+import { executeL1Action, Signature, } from "./_common.js";
+import * as v from "valibot";
+// -------------------- 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."));
+})();
+/** 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."));
+})();
+/**
+ * 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, params, opts) {
+    const action = parser(CreateSubAccountRequest.entries.action)({
+        type: "createSubAccount",
+        ...params,
+    });
+    const expiresAfter = typeof config.defaultExpiresAfter === "number"
+        ? config.defaultExpiresAfter
+        : await config.defaultExpiresAfter?.();
+    return await executeL1Action(config, { action, expiresAfter }, opts?.signal);
+}
+//# sourceMappingURL=createSubAccount.js.map

package/esm/src/api/exchange/createSubAccount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createSubAccount.js","sourceRoot":"","sources":["../../../../src/src/api/exchange/createSubAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAsB,MAAM,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrF,OAAO,EAEL,eAAe,EAIf,SAAS,GACV,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC3D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,yBAAyB;QACzB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,MAAM,CAAC;YACP,sBAAsB;YACtB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAC7B,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;YACD,wBAAwB;YACxB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EACd,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;QACD,2DAA2D;QAC3D,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,sDAAsD,CAAC,CACtE;QACD,+BAA+B;QAC/B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,SAAS,EACT,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;QACD,qCAAqC;QACrC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,2CAA2C;AAC3C,MAAM,CAAC,MAAM,wBAAwB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC5D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,yBAAyB;QACzB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EACf,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;QACD,wBAAwB;QACxB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,MAAM,CAAC;YACP,wBAAwB;YACxB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAC7B,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;YACD,2BAA2B;YAC3B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sCAAsC,CAAC,CACtD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAUL;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,MAAsD,EACtD,MAAiD,EACjD,IAA8B;IAE9B,MAAM,MAAM,GAAG,MAAM,CAAC,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5D,IAAI,EAAE,kBAAkB;QACxB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,MAAM,YAAY,GAAG,OAAO,MAAM,CAAC,mBAAmB,KAAK,QAAQ;QACjE,CAAC,CAAC,MAAM,CAAC,mBAAmB;QAC5B,CAAC,CAAC,MAAM,MAAM,CAAC,mBAAmB,EAAE,EAAE,CAAC;IACzC,OAAO,MAAM,eAAe,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;AAC/E,CAAC"}

package/esm/src/api/exchange/createVault.d.ts

@@ -0,0 +1,120 @@
+import { type DeepImmutable } from "../_common.js";
+import { type ExchangeRequestConfig, type ExtractRequestAction, type ExtractRequestOptions, type MultiSignRequestConfig } from "./_common.js";
+import * as v from "valibot";
+/**
+ * Create a vault.
+ * @see null
+ */
+export declare const CreateVaultRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Action to perform. */
+    readonly action: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Type of action. */
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"createVault", undefined>, v.DescriptionAction<"createVault", "Type of action.">]>;
+        /** Vault name. */
+        readonly name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 3, undefined>, v.DescriptionAction<string, "Vault name.">]>;
+        /** Vault description. */
+        readonly description: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 10, undefined>, v.DescriptionAction<string, "Vault description.">]>;
+        /** Initial balance (float * 1e6). */
+        readonly initialUsd: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.MinValueAction<number, 100000000, undefined>, v.DescriptionAction<number, "Initial balance (float * 1e6).">]>;
+        /** Unique request identifier (current timestamp in ms) (default: Date.now()). */
+        readonly nonce: v.SchemaWithPipe<readonly [v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, () => number>, v.DescriptionAction<number, "Unique request identifier (current timestamp in ms).">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "createVault";
+        name: string;
+        description: string;
+        initialUsd: number;
+        nonce: number;
+    }, "Action to perform.">]>;
+    /** Unique request identifier (current timestamp in ms). */
+    readonly nonce: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Unique request identifier (current timestamp in ms).">]>;
+    /** Cryptographic signature. */
+    readonly signature: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly r: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>, v.TransformAction<`0x${string}`, `0x${string}`>]>, v.DescriptionAction<`0x${string}`, "First 32-byte component of ECDSA signature.">]>;
+        readonly s: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>, v.TransformAction<`0x${string}`, `0x${string}`>]>, v.DescriptionAction<`0x${string}`, "Second 32-byte component of ECDSA signature.">]>;
+        readonly v: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>]>, v.UnionSchema<[v.LiteralSchema<27, undefined>, v.LiteralSchema<28, undefined>], undefined>]>, v.DescriptionAction<27 | 28, "Recovery identifier.">]>;
+    }, undefined>, v.DescriptionAction<{
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    }, "ECDSA signature components for Ethereum typed data.">]>, v.DescriptionAction<{
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    }, "Cryptographic signature.">]>;
+    /** Expiration time of the action. */
+    readonly expiresAfter: v.SchemaWithPipe<readonly [v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | undefined, "Expiration time of the action.">]>;
+}, undefined>, v.DescriptionAction<{
+    action: {
+        type: "createVault";
+        name: string;
+        description: string;
+        initialUsd: number;
+        nonce: number;
+    };
+    nonce: number;
+    signature: {
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    };
+    expiresAfter?: number | undefined;
+}, "Create a vault.">]>;
+export type CreateVaultRequest = v.InferOutput<typeof CreateVaultRequest>;
+/** Response for creating a vault. */
+export declare const CreateVaultResponse: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Successful status. */
+    readonly status: v.SchemaWithPipe<readonly [v.LiteralSchema<"ok", undefined>, v.DescriptionAction<"ok", "Successful status.">]>;
+    /** Response details. */
+    readonly response: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Type of response. */
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"createVault", undefined>, v.DescriptionAction<"createVault", "Type of response.">]>;
+        /** Vault address. */
+        readonly data: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "Vault address.">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "createVault";
+        data: `0x${string}`;
+    }, "Response details.">]>;
+}, undefined>, v.DescriptionAction<{
+    status: "ok";
+    response: {
+        type: "createVault";
+        data: `0x${string}`;
+    };
+}, "Response for creating a vault.">]>;
+export type CreateVaultResponse = v.InferOutput<typeof CreateVaultResponse>;
+/** 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 declare function createVault(config: ExchangeRequestConfig | MultiSignRequestConfig, params: DeepImmutable<CreateVaultParameters>, opts?: CreateVaultOptions): Promise<CreateVaultResponse>;
+//# sourceMappingURL=createVault.d.ts.map

package/esm/src/api/exchange/createVault.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createVault.d.ts","sourceRoot":"","sources":["../../../../src/src/api/exchange/createVault.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,KAAK,aAAa,EAA2B,MAAM,eAAe,CAAC;AACrF,OAAO,EACL,KAAK,qBAAqB,EAE1B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAE5B,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAI7B;;;GAGG;AACH,eAAO,MAAM,kBAAkB;IAGzB,yBAAyB;;QAGrB,sBAAsB;;QAKtB,kBAAkB;;QAMlB,yBAAyB;;QAMzB,qCAAqC;;QAMrC,iFAAiF;;;;;;;;;IAQrF,2DAA2D;;IAK3D,+BAA+B;;;;;;;;;;;;;;IAK/B,qCAAqC;;;;;;;;;;;;;;;;;uBAQvC,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1E,qCAAqC;AACrC,eAAO,MAAM,mBAAmB;IAG1B,yBAAyB;;IAKzB,wBAAwB;;QAGpB,wBAAwB;;QAKxB,qBAAqB;;;;;;;;;;;;sCAW3B,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAI5E,kEAAkE;AAClE,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,CAAC;AAClG,gEAAgE;AAChE,MAAM,MAAM,kBAAkB,GAAG,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,CAAC;AAEhG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAsB,WAAW,CAC/B,MAAM,EAAE,qBAAqB,GAAG,sBAAsB,EACtD,MAAM,EAAE,aAAa,CAAC,qBAAqB,CAAC,EAC5C,IAAI,CAAC,EAAE,kBAAkB,GACxB,OAAO,CAAC,mBAAmB,CAAC,CAS9B"}

package/esm/src/api/exchange/createVault.js

@@ -0,0 +1,88 @@
+import { Address, parser, UnsignedInteger } from "../_common.js";
+import { executeL1Action, Signature, } from "./_common.js";
+import * as v from "valibot";
+// -------------------- 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."));
+})();
+/** 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."));
+})();
+/**
+ * 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, params, opts) {
+    const action = parser(CreateVaultRequest.entries.action)({
+        type: "createVault",
+        ...params,
+    });
+    const expiresAfter = typeof config.defaultExpiresAfter === "number"
+        ? config.defaultExpiresAfter
+        : await config.defaultExpiresAfter?.();
+    return await executeL1Action(config, { action, expiresAfter }, opts?.signal);
+}
+//# sourceMappingURL=createVault.js.map

package/esm/src/api/exchange/createVault.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createVault.js","sourceRoot":"","sources":["../../../../src/src/api/exchange/createVault.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAsB,MAAM,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrF,OAAO,EAEL,eAAe,EAIf,SAAS,GACV,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACtD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,yBAAyB;QACzB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,MAAM,CAAC;YACP,sBAAsB;YACtB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EACxB,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;YACD,kBAAkB;YAClB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EACd,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;YACD,yBAAyB;YACzB,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,EACf,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;YACD,qCAAqC;YACrC,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,eAAe,EACf,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,WAAW;YAClC,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;YACD,iFAAiF;YACjF,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,wDAAwD;YACvG,CAAC,CAAC,WAAW,CAAC,sDAAsD,CAAC,CACtE;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;QACD,2DAA2D;QAC3D,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,sDAAsD,CAAC,CACtE;QACD,+BAA+B;QAC/B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,SAAS,EACT,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;QACD,qCAAqC;QACrC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,qCAAqC;AACrC,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACvD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,yBAAyB;QACzB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EACf,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;QACD,wBAAwB;QACxB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,MAAM,CAAC;YACP,wBAAwB;YACxB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EACxB,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;YACD,qBAAqB;YACrB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAUL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAsD,EACtD,MAA4C,EAC5C,IAAyB;IAEzB,MAAM,MAAM,GAAG,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACvD,IAAI,EAAE,aAAa;QACnB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,MAAM,YAAY,GAAG,OAAO,MAAM,CAAC,mBAAmB,KAAK,QAAQ;QACjE,CAAC,CAAC,MAAM,CAAC,mBAAmB;QAC5B,CAAC,CAAC,MAAM,MAAM,CAAC,mBAAmB,EAAE,EAAE,CAAC;IACzC,OAAO,MAAM,eAAe,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;AAC/E,CAAC"}

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

@@ -0,0 +1,84 @@
+import { type DeepImmutable } from "../_common.js";
+import { type ExchangeRequestConfig, type ExtractRequestAction, type ExtractRequestOptions, type MultiSignRequestConfig } from "./_common.js";
+import * as v from "valibot";
+/**
+ * Configure block type for EVM transactions.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/hyperevm/dual-block-architecture
+ */
+export declare const EvmUserModifyRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Action to perform. */
+    readonly action: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Type of action. */
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"evmUserModify", undefined>, v.DescriptionAction<"evmUserModify", "Type of action.">]>;
+        /** `true` for large blocks, `false` for small blocks. */
+        readonly usingBigBlocks: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "`true` for large blocks, `false` for small blocks.">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "evmUserModify";
+        usingBigBlocks: boolean;
+    }, "Action to perform.">]>;
+    /** Unique request identifier (current timestamp in ms). */
+    readonly nonce: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Unique request identifier (current timestamp in ms).">]>;
+    /** Cryptographic signature. */
+    readonly signature: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly r: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>, v.TransformAction<`0x${string}`, `0x${string}`>]>, v.DescriptionAction<`0x${string}`, "First 32-byte component of ECDSA signature.">]>;
+        readonly s: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>, v.TransformAction<`0x${string}`, `0x${string}`>]>, v.DescriptionAction<`0x${string}`, "Second 32-byte component of ECDSA signature.">]>;
+        readonly v: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>]>, v.UnionSchema<[v.LiteralSchema<27, undefined>, v.LiteralSchema<28, undefined>], undefined>]>, v.DescriptionAction<27 | 28, "Recovery identifier.">]>;
+    }, undefined>, v.DescriptionAction<{
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    }, "ECDSA signature components for Ethereum typed data.">]>, v.DescriptionAction<{
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    }, "Cryptographic signature.">]>;
+    /** Expiration time of the action. */
+    readonly expiresAfter: v.SchemaWithPipe<readonly [v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | undefined, "Expiration time of the action.">]>;
+}, undefined>, v.DescriptionAction<{
+    action: {
+        type: "evmUserModify";
+        usingBigBlocks: boolean;
+    };
+    nonce: number;
+    signature: {
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    };
+    expiresAfter?: number | undefined;
+}, "Configure block type for EVM transactions.">]>;
+export type EvmUserModifyRequest = v.InferOutput<typeof EvmUserModifyRequest>;
+import { SuccessResponse } from "./_common.js";
+export { SuccessResponse };
+/** 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 declare function evmUserModify(config: ExchangeRequestConfig | MultiSignRequestConfig, params: DeepImmutable<EvmUserModifyParameters>, opts?: EvmUserModifyOptions): Promise<SuccessResponse>;
+//# sourceMappingURL=evmUserModify.d.ts.map

package/esm/src/api/exchange/evmUserModify.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"evmUserModify.d.ts","sourceRoot":"","sources":["../../../../src/src/api/exchange/evmUserModify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAA2B,MAAM,eAAe,CAAC;AAC5E,OAAO,EACL,KAAK,qBAAqB,EAE1B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAE5B,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAI7B;;;GAGG;AACH,eAAO,MAAM,oBAAoB;IAG3B,yBAAyB;;QAGrB,sBAAsB;;QAKtB,yDAAyD;;;;;;IAQ7D,2DAA2D;;IAK3D,+BAA+B;;;;;;;;;;;;;;IAK/B,qCAAqC;;;;;;;;;;;;;;kDAQvC,CAAC;AACL,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAE9E,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,CAAC;AAI3B,oEAAoE;AACpE,MAAM,MAAM,uBAAuB,GAAG,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC,CAAC;AACtG,kEAAkE;AAClE,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC,CAAC;AAEpG;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,aAAa,CACjC,MAAM,EAAE,qBAAqB,GAAG,sBAAsB,EACtD,MAAM,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC9C,IAAI,CAAC,EAAE,oBAAoB,GAC1B,OAAO,CAAC,eAAe,CAAC,CAS1B"}

package/esm/src/api/exchange/evmUserModify.js

@@ -0,0 +1,64 @@
+import { parser, UnsignedInteger } from "../_common.js";
+import { executeL1Action, 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."));
+})();
+import { SuccessResponse } from "./_common.js";
+export { SuccessResponse };
+/**
+ * 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, params, opts) {
+    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);
+}
+//# sourceMappingURL=evmUserModify.js.map

package/esm/src/api/exchange/evmUserModify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"evmUserModify.js","sourceRoot":"","sources":["../../../../src/src/api/exchange/evmUserModify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,MAAM,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC5E,OAAO,EAEL,eAAe,EAIf,SAAS,GACV,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACxD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,yBAAyB;QACzB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,MAAM,CAAC;YACP,sBAAsB;YACtB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,EAC1B,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;YACD,yDAAyD;YACzD,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,oDAAoD,CAAC,CACpE;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;QACD,2DAA2D;QAC3D,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,sDAAsD,CAAC,CACtE;QACD,+BAA+B;QAC/B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,SAAS,EACT,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;QACD,qCAAqC;QACrC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,4CAA4C,CAAC,CAC5D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,CAAC;AAS3B;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAsD,EACtD,MAA8C,EAC9C,IAA2B;IAE3B,MAAM,MAAM,GAAG,MAAM,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzD,IAAI,EAAE,eAAe;QACrB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,MAAM,YAAY,GAAG,OAAO,MAAM,CAAC,mBAAmB,KAAK,QAAQ;QACjE,CAAC,CAAC,MAAM,CAAC,mBAAmB;QAC5B,CAAC,CAAC,MAAM,MAAM,CAAC,mBAAmB,EAAE,EAAE,CAAC;IACzC,OAAO,MAAM,eAAe,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;AAC/E,CAAC"}