@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.1

package/script/src/api/exchange/scheduleCancel.d.ts

@@ -0,0 +1,93 @@
+import { type DeepImmutable } from "../_common.js";
+import { type ExchangeRequestConfig, type ExtractRequestAction, type ExtractRequestOptions, type MultiSignRequestConfig } from "./_common.js";
+import * as v from "valibot";
+/**
+ * Schedule a cancel-all operation at a future time.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#schedule-cancel-dead-mans-switch
+ */
+export declare const ScheduleCancelRequest: 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<"scheduleCancel", undefined>, v.DescriptionAction<"scheduleCancel", "Type of action.">]>;
+        /**
+         * Scheduled time (in ms since epoch).
+         * Must be at least 5 seconds in the future.
+         *
+         * If not specified, will cause all scheduled cancel operations to be deleted.
+         */
+        readonly time: 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, string>]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "scheduleCancel";
+        time?: number | undefined;
+    }, "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.">]>;
+    /** Vault address (for vault trading). */
+    readonly vaultAddress: v.SchemaWithPipe<readonly [v.OptionalSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, undefined>, v.DescriptionAction<`0x${string}` | undefined, "Vault address (for vault trading).">]>;
+    /** 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: "scheduleCancel";
+        time?: number | undefined;
+    };
+    nonce: number;
+    signature: {
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    };
+    vaultAddress?: `0x${string}` | undefined;
+    expiresAfter?: number | undefined;
+}, "Schedule a cancel-all operation at a future time.">]>;
+export type ScheduleCancelRequest = v.InferOutput<typeof ScheduleCancelRequest>;
+import { SuccessResponse } from "./_common.js";
+export { SuccessResponse };
+/** Action parameters for the {@linkcode scheduleCancel} function. */
+export type ScheduleCancelParameters = ExtractRequestAction<v.InferInput<typeof ScheduleCancelRequest>>;
+/** Request options for the {@linkcode scheduleCancel} function. */
+export type ScheduleCancelOptions = ExtractRequestOptions<v.InferInput<typeof ScheduleCancelRequest>>;
+/**
+ * Schedule a cancel-all operation at a future time.
+ * @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#schedule-cancel-dead-mans-switch
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { scheduleCancel } 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 scheduleCancel(
+ *   { transport, wallet },
+ *   { time: Date.now() + 10_000 },
+ * );
+ * ```
+ */
+export declare function scheduleCancel(config: ExchangeRequestConfig | MultiSignRequestConfig, params?: DeepImmutable<ScheduleCancelParameters>, opts?: ScheduleCancelOptions): Promise<SuccessResponse>;
+export declare function scheduleCancel(config: ExchangeRequestConfig | MultiSignRequestConfig, opts?: ScheduleCancelOptions): Promise<SuccessResponse>;
+//# sourceMappingURL=scheduleCancel.d.ts.map

package/script/src/api/exchange/scheduleCancel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduleCancel.d.ts","sourceRoot":"","sources":["../../../../src/src/api/exchange/scheduleCancel.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,qBAAqB;IAG5B,yBAAyB;;QAGrB,sBAAsB;;QAKtB;;;;;WAKG;;;;;;IAYP,2DAA2D;;IAK3D,+BAA+B;;;;;;;;;;;;;;IAK/B,yCAAyC;;IAKzC,qCAAqC;;;;;;;;;;;;;;;yDAQvC,CAAC;AACL,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEhF,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,CAAC;AAI3B,qEAAqE;AACrE,MAAM,MAAM,wBAAwB,GAAG,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC,CAAC;AACxG,mEAAmE;AACnE,MAAM,MAAM,qBAAqB,GAAG,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC,CAAC;AAEtG;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,qBAAqB,GAAG,sBAAsB,EACtD,MAAM,CAAC,EAAE,aAAa,CAAC,wBAAwB,CAAC,EAChD,IAAI,CAAC,EAAE,qBAAqB,GAC3B,OAAO,CAAC,eAAe,CAAC,CAAC;AAC5B,wBAAsB,cAAc,CAClC,MAAM,EAAE,qBAAqB,GAAG,sBAAsB,EACtD,IAAI,CAAC,EAAE,qBAAqB,GAC3B,OAAO,CAAC,eAAe,CAAC,CAAC"}

package/script/src/api/exchange/scheduleCancel.js

@@ -0,0 +1,88 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SuccessResponse = exports.ScheduleCancelRequest = void 0;
+exports.scheduleCancel = scheduleCancel;
+const _common_js_1 = require("../_common.js");
+const _common_js_2 = require("./_common.js");
+const v = __importStar(require("valibot"));
+// -------------------- Schemas --------------------
+/**
+ * Schedule a cancel-all operation at a future time.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#schedule-cancel-dead-mans-switch
+ */
+exports.ScheduleCancelRequest = (() => {
+    return v.pipe(v.object({
+        /** Action to perform. */
+        action: v.pipe(v.object({
+            /** Type of action. */
+            type: v.pipe(v.literal("scheduleCancel"), v.description("Type of action.")),
+            /**
+             * Scheduled time (in ms since epoch).
+             * Must be at least 5 seconds in the future.
+             *
+             * If not specified, will cause all scheduled cancel operations to be deleted.
+             */
+            time: v.pipe(v.optional(_common_js_1.UnsignedInteger), v.description("Scheduled time (in ms since epoch)." +
+                "\nMust be at least 5 seconds in the future." +
+                "\n\nIf not specified, will cause all scheduled cancel operations to be deleted.")),
+        }), v.description("Action to perform.")),
+        /** Unique request identifier (current timestamp in ms). */
+        nonce: v.pipe(_common_js_1.UnsignedInteger, v.description("Unique request identifier (current timestamp in ms).")),
+        /** Cryptographic signature. */
+        signature: v.pipe(_common_js_2.Signature, v.description("Cryptographic signature.")),
+        /** Vault address (for vault trading). */
+        vaultAddress: v.pipe(v.optional(_common_js_1.Address), v.description("Vault address (for vault trading).")),
+        /** Expiration time of the action. */
+        expiresAfter: v.pipe(v.optional(_common_js_1.UnsignedInteger), v.description("Expiration time of the action.")),
+    }), v.description("Schedule a cancel-all operation at a future time."));
+})();
+const _common_js_3 = require("./_common.js");
+Object.defineProperty(exports, "SuccessResponse", { enumerable: true, get: function () { return _common_js_3.SuccessResponse; } });
+async function scheduleCancel(config, paramsOrOpts, maybeOpts) {
+    const isFirstArgParams = paramsOrOpts && "time" in paramsOrOpts;
+    const params = isFirstArgParams ? paramsOrOpts : {};
+    const opts = isFirstArgParams ? maybeOpts : paramsOrOpts;
+    const action = (0, _common_js_1.parser)(exports.ScheduleCancelRequest.entries.action)({
+        type: "scheduleCancel",
+        ...params,
+    });
+    const vaultAddress = opts?.vaultAddress ?? config.defaultVaultAddress;
+    const expiresAfter = typeof config.defaultExpiresAfter === "number"
+        ? config.defaultExpiresAfter
+        : await config.defaultExpiresAfter?.();
+    return await (0, _common_js_2.executeL1Action)(config, { action, vaultAddress, expiresAfter }, opts?.signal);
+}
+//# sourceMappingURL=scheduleCancel.js.map

package/script/src/api/exchange/scheduleCancel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduleCancel.js","sourceRoot":"","sources":["../../../../src/src/api/exchange/scheduleCancel.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoHA,wCAoBC;AAxID,8CAAqF;AACrF,6CAOsB;AACtB,2CAA6B;AAE7B,oDAAoD;AAEpD;;;GAGG;AACU,QAAA,qBAAqB,GAAmB,CAAC,GAAG,EAAE;IACzD,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,gBAAgB,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;YACD;;;;;eAKG;YACH,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,QAAQ,CAAC,4BAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CACX,qCAAqC;gBACnC,6CAA6C;gBAC7C,iFAAiF,CACpF,CACF;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;QACD,2DAA2D;QAC3D,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,sDAAsD,CAAC,CACtE;QACD,+BAA+B;QAC/B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,sBAAS,EACT,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;QACD,yCAAyC;QACzC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,QAAQ,CAAC,oBAAO,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,oCAAoC,CAAC,CACpD;QACD,qCAAqC;QACrC,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,QAAQ,CAAC,4BAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,mDAAmD,CAAC,CACnE,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,6CAA+C;AACtC,gGADA,4BAAe,OACA;AA4CjB,KAAK,UAAU,cAAc,CAClC,MAAsD,EACtD,YAEyB,EACzB,SAAiC;IAEjC,MAAM,gBAAgB,GAAG,YAAY,IAAI,MAAM,IAAI,YAAY,CAAC;IAChE,MAAM,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;IACpD,MAAM,IAAI,GAAG,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAqC,CAAC;IAElF,MAAM,MAAM,GAAG,IAAA,mBAAM,EAAC,6BAAqB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1D,IAAI,EAAE,gBAAgB;QACtB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,MAAM,YAAY,GAAG,IAAI,EAAE,YAAY,IAAI,MAAM,CAAC,mBAAmB,CAAC;IACtE,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,IAAA,4BAAe,EAAC,MAAM,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;AAC7F,CAAC"}

package/script/src/api/exchange/sendAsset.d.ts

@@ -0,0 +1,126 @@
+import { type DeepImmutable } from "../_common.js";
+import { type ExchangeRequestConfig, type ExtractRequestAction, type ExtractRequestOptions, type MultiSignRequestConfig } from "./_common.js";
+import * as v from "valibot";
+/**
+ * Transfer tokens between different perp DEXs, spot balance, users, and/or sub-accounts.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#send-asset-testnet-only
+ */
+export declare const SendAssetRequest: 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<"sendAsset", undefined>, v.DescriptionAction<"sendAsset", "Type of action.">]>;
+        /** Chain ID used for signing. */
+        readonly signatureChainId: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.DescriptionAction<`0x${string}`, "Chain ID used for signing.">]>;
+        /** HyperLiquid network. */
+        readonly hyperliquidChain: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"Mainnet", undefined>, v.LiteralSchema<"Testnet", undefined>], undefined>, v.DescriptionAction<"Testnet" | "Mainnet", "HyperLiquid network.">]>;
+        /** Destination address. */
+        readonly destination: 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}`, "Destination address.">]>;
+        /** Source DEX ("" for default USDC perp DEX, "spot" for spot). */
+        readonly sourceDex: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Source DEX (\"\" for default USDC perp DEX, \"spot\" for spot).">]>;
+        /** Destination DEX ("" for default USDC perp DEX, "spot" for spot). */
+        readonly destinationDex: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Destination DEX (\"\" for default USDC perp DEX, \"spot\" for spot).">]>;
+        /** Token identifier. */
+        readonly token: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `${string}:0x${string}`>]>, v.DescriptionAction<`${string}:0x${string}`, "Token identifier.">]>;
+        /** Amount to send (not in wei). */
+        readonly amount: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Amount to send (not in wei).">]>;
+        /** Source sub-account address ("" for main account) (default: ""). */
+        readonly fromSubAccount: v.SchemaWithPipe<readonly [v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"", undefined>, v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>], undefined>, "">, v.DescriptionAction<"" | `0x${string}`, "Source sub-account address (\"\" for main account).">]>;
+        /** 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).">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "sendAsset";
+        signatureChainId: `0x${string}`;
+        hyperliquidChain: "Testnet" | "Mainnet";
+        destination: `0x${string}`;
+        sourceDex: string;
+        destinationDex: string;
+        token: `${string}:0x${string}`;
+        amount: string;
+        fromSubAccount: "" | `0x${string}`;
+        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.">]>;
+}, undefined>, v.DescriptionAction<{
+    action: {
+        type: "sendAsset";
+        signatureChainId: `0x${string}`;
+        hyperliquidChain: "Testnet" | "Mainnet";
+        destination: `0x${string}`;
+        sourceDex: string;
+        destinationDex: string;
+        token: `${string}:0x${string}`;
+        amount: string;
+        fromSubAccount: "" | `0x${string}`;
+        nonce: number;
+    };
+    nonce: number;
+    signature: {
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    };
+}, "Transfer tokens between different perp DEXs, spot balance, users, and/or sub-accounts.">]>;
+export type SendAssetRequest = v.InferOutput<typeof SendAssetRequest>;
+import { SuccessResponse } from "./_common.js";
+export { SuccessResponse };
+/** Action parameters for the {@linkcode sendAsset} function. */
+export type SendAssetParameters = ExtractRequestAction<v.InferInput<typeof SendAssetRequest>>;
+/** Request options for the {@linkcode sendAsset} function. */
+export type SendAssetOptions = ExtractRequestOptions<v.InferInput<typeof SendAssetRequest>>;
+/** EIP-712 types for the {@linkcode sendAsset} function. */
+export declare const SendAssetTypes: {
+    "HyperliquidTransaction:SendAsset": {
+        name: string;
+        type: string;
+    }[];
+};
+/**
+ * Transfer tokens between different perp DEXs, spot balance, users, and/or sub-accounts.
+ * @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#send-asset-testnet-only
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { sendAsset } 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 sendAsset(
+ *   { transport, wallet },
+ *   {
+ *     destination: "0x0000000000000000000000000000000000000001",
+ *     sourceDex: "",
+ *     destinationDex: "test",
+ *     token: "USDC:0xeb62eee3685fc4c43992febcd9e75443",
+ *     amount: "1",
+ *   },
+ * );
+ * ```
+ */
+export declare function sendAsset(config: ExchangeRequestConfig | MultiSignRequestConfig, params: DeepImmutable<SendAssetParameters>, opts?: SendAssetOptions): Promise<SuccessResponse>;
+//# sourceMappingURL=sendAsset.d.ts.map

package/script/src/api/exchange/sendAsset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendAsset.d.ts","sourceRoot":"","sources":["../../../../src/src/api/exchange/sendAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,KAAK,aAAa,EAA0D,MAAM,eAAe,CAAC;AACpH,OAAO,EACL,KAAK,qBAAqB,EAE1B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAG1B,KAAK,sBAAsB,EAE5B,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAI7B;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAGvB,yBAAyB;;QAGrB,sBAAsB;;QAKtB,iCAAiC;;QAKjC,2BAA2B;;QAK3B,2BAA2B;;QAK3B,kEAAkE;;QAKlE,uEAAuE;;QAKvE,wBAAwB;;QAKxB,mCAAmC;;QAKnC,sEAAsE;;QAKtE,2DAA2D;;;;;;;;;;;;;;IAQ/D,2DAA2D;;IAK3D,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8FAQjC,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEtE,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,CAAC;AAI3B,gEAAgE;AAChE,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC,CAAC;AAC9F,8DAA8D;AAC9D,MAAM,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC,CAAC;AAE5F,4DAA4D;AAC5D,eAAO,MAAM,cAAc;;;;;CAW1B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE,qBAAqB,GAAG,sBAAsB,EACtD,MAAM,EAAE,aAAa,CAAC,mBAAmB,CAAC,EAC1C,IAAI,CAAC,EAAE,gBAAgB,GACtB,OAAO,CAAC,eAAe,CAAC,CAa1B"}

package/script/src/api/exchange/sendAsset.js

@@ -0,0 +1,134 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SendAssetTypes = exports.SuccessResponse = exports.SendAssetRequest = void 0;
+exports.sendAsset = sendAsset;
+const _common_js_1 = require("../_common.js");
+const _common_js_2 = require("./_common.js");
+const v = __importStar(require("valibot"));
+// -------------------- Schemas --------------------
+/**
+ * Transfer tokens between different perp DEXs, spot balance, users, and/or sub-accounts.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#send-asset-testnet-only
+ */
+exports.SendAssetRequest = (() => {
+    return v.pipe(v.object({
+        /** Action to perform. */
+        action: v.pipe(v.object({
+            /** Type of action. */
+            type: v.pipe(v.literal("sendAsset"), v.description("Type of action.")),
+            /** Chain ID used for signing. */
+            signatureChainId: v.pipe(_common_js_1.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.")),
+            /** Destination address. */
+            destination: v.pipe(_common_js_1.Address, v.description("Destination address.")),
+            /** Source DEX ("" for default USDC perp DEX, "spot" for spot). */
+            sourceDex: v.pipe(v.string(), v.description('Source DEX ("" for default USDC perp DEX, "spot" for spot).')),
+            /** Destination DEX ("" for default USDC perp DEX, "spot" for spot). */
+            destinationDex: v.pipe(v.string(), v.description('Destination DEX ("" for default USDC perp DEX, "spot" for spot).')),
+            /** Token identifier. */
+            token: v.pipe(_common_js_1.TokenId, v.description("Token identifier.")),
+            /** Amount to send (not in wei). */
+            amount: v.pipe(_common_js_1.UnsignedDecimal, v.description("Amount to send (not in wei).")),
+            /** Source sub-account address ("" for main account) (default: ""). */
+            fromSubAccount: v.pipe(v.optional(v.union([v.literal(""), _common_js_1.Address]), ""), v.description('Source sub-account address ("" for main account).')),
+            /** Unique request identifier (current timestamp in ms). */
+            nonce: v.pipe(_common_js_1.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(_common_js_1.UnsignedInteger, v.description("Unique request identifier (current timestamp in ms).")),
+        /** Cryptographic signature. */
+        signature: v.pipe(_common_js_2.Signature, v.description("Cryptographic signature.")),
+    }), v.description("Transfer tokens between different perp DEXs, spot balance, users, and/or sub-accounts."));
+})();
+const _common_js_3 = require("./_common.js");
+Object.defineProperty(exports, "SuccessResponse", { enumerable: true, get: function () { return _common_js_3.SuccessResponse; } });
+/** EIP-712 types for the {@linkcode sendAsset} function. */
+exports.SendAssetTypes = {
+    "HyperliquidTransaction:SendAsset": [
+        { name: "hyperliquidChain", type: "string" },
+        { name: "destination", type: "string" },
+        { name: "sourceDex", type: "string" },
+        { name: "destinationDex", type: "string" },
+        { name: "token", type: "string" },
+        { name: "amount", type: "string" },
+        { name: "fromSubAccount", type: "string" },
+        { name: "nonce", type: "uint64" },
+    ],
+};
+/**
+ * Transfer tokens between different perp DEXs, spot balance, users, and/or sub-accounts.
+ * @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#send-asset-testnet-only
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { sendAsset } 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 sendAsset(
+ *   { transport, wallet },
+ *   {
+ *     destination: "0x0000000000000000000000000000000000000001",
+ *     sourceDex: "",
+ *     destinationDex: "test",
+ *     token: "USDC:0xeb62eee3685fc4c43992febcd9e75443",
+ *     amount: "1",
+ *   },
+ * );
+ * ```
+ */
+async function sendAsset(config, params, opts) {
+    const action = (0, _common_js_1.parser)(exports.SendAssetRequest.entries.action)({
+        type: "sendAsset",
+        hyperliquidChain: config.transport.isTestnet ? "Testnet" : "Mainnet",
+        signatureChainId: await (0, _common_js_2.getSignatureChainId)(config),
+        nonce: await (0, _common_js_2.getNonce)(config),
+        ...params,
+    });
+    return await (0, _common_js_2.executeUserSignedAction)(config, { action, types: exports.SendAssetTypes }, opts?.signal);
+}
+//# sourceMappingURL=sendAsset.js.map

package/script/src/api/exchange/sendAsset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendAsset.js","sourceRoot":"","sources":["../../../../src/src/api/exchange/sendAsset.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsJA,8BAiBC;AAvKD,8CAAoH;AACpH,6CASsB;AACtB,2CAA6B;AAE7B,oDAAoD;AAEpD;;;GAGG;AACU,QAAA,gBAAgB,GAAmB,CAAC,GAAG,EAAE;IACpD,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,WAAW,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;YACD,iCAAiC;YACjC,gBAAgB,EAAE,CAAC,CAAC,IAAI,CACtB,gBAAG,EACH,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;YACD,2BAA2B;YAC3B,gBAAgB,EAAE,CAAC,CAAC,IAAI,CACtB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EACrD,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;YACD,2BAA2B;YAC3B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,oBAAO,EACP,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;YACD,kEAAkE;YAClE,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,6DAA6D,CAAC,CAC7E;YACD,uEAAuE;YACvE,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,kEAAkE,CAAC,CAClF;YACD,wBAAwB;YACxB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,oBAAO,EACP,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;YACD,mCAAmC;YACnC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;YACD,sEAAsE;YACtE,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,oBAAO,CAAC,CAAC,EAAE,EAAE,CAAC,EACjD,CAAC,CAAC,WAAW,CAAC,mDAAmD,CAAC,CACnE;YACD,2DAA2D;YAC3D,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,4BAAe,EACf,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,4BAAe,EACf,CAAC,CAAC,WAAW,CAAC,sDAAsD,CAAC,CACtE;QACD,+BAA+B;QAC/B,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,sBAAS,EACT,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,wFAAwF,CAAC,CACxG,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,6CAA+C;AACtC,gGADA,4BAAe,OACA;AASxB,4DAA4D;AAC/C,QAAA,cAAc,GAAG;IAC5B,kCAAkC,EAAE;QAClC,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC5C,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE;QACvC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE;QACrC,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1C,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE;QACjC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE;QAClC,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1C,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE;KAClC;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACI,KAAK,UAAU,SAAS,CAC7B,MAAsD,EACtD,MAA0C,EAC1C,IAAuB;IAEvB,MAAM,MAAM,GAAG,IAAA,mBAAM,EAAC,wBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,EAAE,WAAW;QACjB,gBAAgB,EAAE,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;QACpE,gBAAgB,EAAE,MAAM,IAAA,gCAAmB,EAAC,MAAM,CAAC;QACnD,KAAK,EAAE,MAAM,IAAA,qBAAQ,EAAC,MAAM,CAAC;QAC7B,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,IAAA,oCAAuB,EAClC,MAAM,EACN,EAAE,MAAM,EAAE,KAAK,EAAE,sBAAc,EAAE,EACjC,IAAI,EAAE,MAAM,CACb,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,88 @@
+import { type DeepImmutable } from "../_common.js";
+import { type ExchangeRequestConfig, type ExtractRequestAction, type ExtractRequestOptions, type MultiSignRequestConfig } from "./_common.js";
+import * as v from "valibot";
+/**
+ * Set the display name in the leaderboard.
+ * @see null
+ */
+export declare const SetDisplayNameRequest: 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<"setDisplayName", undefined>, v.DescriptionAction<"setDisplayName", "Type of action.">]>;
+        /**
+         * Display name.
+         *
+         * Set to an empty string to remove the display name.
+         */
+        readonly displayName: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, string>]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "setDisplayName";
+        displayName: string;
+    }, "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: "setDisplayName";
+        displayName: string;
+    };
+    nonce: number;
+    signature: {
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    };
+    expiresAfter?: number | undefined;
+}, "Set the display name in the leaderboard.">]>;
+export type SetDisplayNameRequest = v.InferOutput<typeof SetDisplayNameRequest>;
+import { SuccessResponse } from "./_common.js";
+export { SuccessResponse };
+/** 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>>;
+/**
+ * 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.
+ *
+ * @see null
+ * @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 declare function setDisplayName(config: ExchangeRequestConfig | MultiSignRequestConfig, params: DeepImmutable<SetDisplayNameParameters>, opts?: SetDisplayNameOptions): Promise<SuccessResponse>;
+//# sourceMappingURL=setDisplayName.d.ts.map

package/script/src/api/exchange/setDisplayName.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setDisplayName.d.ts","sourceRoot":"","sources":["../../../../src/src/api/exchange/setDisplayName.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,qBAAqB;IAG5B,yBAAyB;;QAGrB,sBAAsB;;QAKtB;;;;WAIG;;;;;;IAWP,2DAA2D;;IAK3D,+BAA+B;;;;;;;;;;;;;;IAK/B,qCAAqC;;;;;;;;;;;;;;gDAQvC,CAAC;AACL,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEhF,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,CAAC;AAI3B,qEAAqE;AACrE,MAAM,MAAM,wBAAwB,GAAG,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC,CAAC;AACxG,mEAAmE;AACnE,MAAM,MAAM,qBAAqB,GAAG,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC,CAAC;AAEtG;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,qBAAqB,GAAG,sBAAsB,EACtD,MAAM,EAAE,aAAa,CAAC,wBAAwB,CAAC,EAC/C,IAAI,CAAC,EAAE,qBAAqB,GAC3B,OAAO,CAAC,eAAe,CAAC,CAS1B"}