@hfunlabs/hyperliquid 0.27.1-hfunlabs.1

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

@@ -0,0 +1,158 @@
+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
+ */
+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.StringSchema<undefined>, 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.NumberSchema<undefined>, v.IntegerAction<number, undefined>, 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.NumberSchema<undefined>, v.IntegerAction<number, undefined>, 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.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.DescriptionAction<`0x${string}`, "Second 32-byte component of ECDSA signature.">]>;
+        readonly v: v.SchemaWithPipe<readonly [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>;
+/**
+ * Successful response without specific data or error response.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#send-asset
+ */
+export declare const SendAssetResponse: v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    readonly status: v.SchemaWithPipe<readonly [v.LiteralSchema<"ok", undefined>, v.DescriptionAction<"ok", "Successful status.">]>;
+    readonly response: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"default", undefined>, v.DescriptionAction<"default", "Type of response.">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "default";
+    }, "Response details.">]>;
+}, undefined>, v.DescriptionAction<{
+    status: "ok";
+    response: {
+        type: "default";
+    };
+}, "Successful response without specific data.">]>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    readonly status: v.SchemaWithPipe<readonly [v.LiteralSchema<"err", undefined>, v.DescriptionAction<"err", "Error status.">]>;
+    readonly response: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Error message.">]>;
+}, undefined>, v.DescriptionAction<{
+    status: "err";
+    response: string;
+}, "Error response for failed operations.">]>], undefined>, v.DescriptionAction<{
+    status: "err";
+    response: string;
+} | {
+    status: "ok";
+    response: {
+        type: "default";
+    };
+}, "Successful response without specific data or error response.">]>;
+export type SendAssetResponse = v.InferOutput<typeof SendAssetResponse>;
+import { type DeepImmutable } from "../_base.js";
+import { type ExchangeRequestConfig, type ExcludeErrorResponse, type ExtractRequestAction, type ExtractRequestOptions, type MultiSignRequestConfig } from "./_base/mod.js";
+/** 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>>;
+/** Successful variant of {@linkcode SendAssetResponse} without errors. */
+export type SendAssetSuccessResponse = ExcludeErrorResponse<SendAssetResponse>;
+/** 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
+ * @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<SendAssetSuccessResponse>;
+//# sourceMappingURL=sendAsset.d.ts.map

package/esm/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,KAAK,CAAC,MAAM,SAAS,CAAC;AAS7B;;;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;;;GAGG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;oEAK1B,CAAC;AACL,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAMxE,OAAO,EAAE,KAAK,aAAa,EAAU,MAAM,aAAa,CAAC;AACzD,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EAEzB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAE1B,KAAK,sBAAsB,EAC5B,MAAM,gBAAgB,CAAC;AAExB,gEAAgE;AAChE,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC,CAAC;AAE9F,8DAA8D;AAC9D,MAAM,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC,CAAC;AAE5F,0EAA0E;AAC1E,MAAM,MAAM,wBAAwB,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;AAE/E,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,wBAAwB,CAAC,CAiBnC"}

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

@@ -0,0 +1,117 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { Address, Hex, TokenId, UnsignedDecimal, UnsignedInteger } from "../_base.js";
+import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.js";
+/**
+ * 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
+ */
+export const SendAssetRequest = /* @__PURE__ */ (() => {
+    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(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(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(TokenId, v.description("Token identifier.")),
+            /** Amount to send (not in wei). */
+            amount: v.pipe(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(""), Address]), ""), v.description('Source sub-account address ("" for main account).')),
+            /** Unique request identifier (current timestamp in ms). */
+            nonce: v.pipe(UnsignedInteger, v.description("Unique request identifier (current timestamp in ms).")),
+        }), v.description("Action to perform.")),
+        /** Unique request identifier (current timestamp in ms). */
+        nonce: v.pipe(UnsignedInteger, v.description("Unique request identifier (current timestamp in ms).")),
+        /** Cryptographic signature. */
+        signature: v.pipe(Signature, v.description("Cryptographic signature.")),
+    }), v.description("Transfer tokens between different perp DEXs, spot balance, users, and/or sub-accounts."));
+})();
+/**
+ * Successful response without specific data or error response.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#send-asset
+ */
+export const SendAssetResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.union([SuccessResponse, ErrorResponse]), v.description("Successful response without specific data or error response."));
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parser } from "../_base.js";
+import { executeUserSignedAction, getSignatureChainId, } from "./_base/mod.js";
+/** EIP-712 types for the {@linkcode sendAsset} function. */
+export const 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
+ * @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 async function sendAsset(config, params, opts) {
+    const request = parser(SendAssetRequest)({
+        action: {
+            type: "sendAsset",
+            hyperliquidChain: config.transport.isTestnet ? "Testnet" : "Mainnet",
+            signatureChainId: await getSignatureChainId(config),
+            nonce: 0, // Placeholder; actual nonce generated in `executeUserSignedAction` to prevent race conditions
+            ...params,
+        },
+        nonce: 0, // Placeholder; actual nonce generated in `executeUserSignedAction` to prevent race conditions
+        signature: {
+            r: "0x0000000000000000000000000000000000000000000000000000000000000000",
+            s: "0x0000000000000000000000000000000000000000000000000000000000000000",
+            v: 27,
+        },
+    });
+    return await executeUserSignedAction(config, request, SendAssetTypes, opts?.signal);
+}
+//# sourceMappingURL=sendAsset.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sendAsset.js","sourceRoot":"","sources":["../../../../src/src/api/exchange/sendAsset.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACtF,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAE3E;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC,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,GAAG,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,OAAO,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,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;YACD,mCAAmC;YACnC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,eAAe,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,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,EACjD,CAAC,CAAC,WAAW,CAAC,mDAAmD,CAAC,CACnE;YACD,2DAA2D;YAC3D,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,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,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;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,wFAAwF,CAAC,CACxG,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACrD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK,CAAC,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC,EACzC,CAAC,CAAC,WAAW,CAAC,8DAA8D,CAAC,CAC9E,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,OAAO,EAAsB,MAAM,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EAGL,uBAAuB,EAGvB,mBAAmB,GAEpB,MAAM,gBAAgB,CAAC;AAWxB,4DAA4D;AAC5D,MAAM,CAAC,MAAM,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;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,MAAsD,EACtD,MAA0C,EAC1C,IAAuB;IAEvB,MAAM,OAAO,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACvC,MAAM,EAAE;YACN,IAAI,EAAE,WAAW;YACjB,gBAAgB,EAAE,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;YACpE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC,MAAM,CAAC;YACnD,KAAK,EAAE,CAAC,EAAE,8FAA8F;YACxG,GAAG,MAAM;SACV;QACD,KAAK,EAAE,CAAC,EAAE,8FAA8F;QACxG,SAAS,EAAE;YACT,CAAC,EAAE,oEAAoE;YACvE,CAAC,EAAE,oEAAoE;YACvE,CAAC,EAAE,EAAE;SACN;KACF,CAAC,CAAC;IACH,OAAO,MAAM,uBAAuB,CAAC,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;AACtF,CAAC"}

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

@@ -0,0 +1,113 @@
+import * as v from "valibot";
+/** Set the display name in the leaderboard. */
+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.NumberSchema<undefined>, v.IntegerAction<number, undefined>, 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.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.DescriptionAction<`0x${string}`, "Second 32-byte component of ECDSA signature.">]>;
+        readonly v: v.SchemaWithPipe<readonly [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.NumberSchema<undefined>, v.IntegerAction<number, undefined>, 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>;
+/** Successful response without specific data or error response. */
+export declare const SetDisplayNameResponse: v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    readonly status: v.SchemaWithPipe<readonly [v.LiteralSchema<"ok", undefined>, v.DescriptionAction<"ok", "Successful status.">]>;
+    readonly response: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"default", undefined>, v.DescriptionAction<"default", "Type of response.">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "default";
+    }, "Response details.">]>;
+}, undefined>, v.DescriptionAction<{
+    status: "ok";
+    response: {
+        type: "default";
+    };
+}, "Successful response without specific data.">]>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    readonly status: v.SchemaWithPipe<readonly [v.LiteralSchema<"err", undefined>, v.DescriptionAction<"err", "Error status.">]>;
+    readonly response: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Error message.">]>;
+}, undefined>, v.DescriptionAction<{
+    status: "err";
+    response: string;
+}, "Error response for failed operations.">]>], undefined>, v.DescriptionAction<{
+    status: "err";
+    response: string;
+} | {
+    status: "ok";
+    response: {
+        type: "default";
+    };
+}, "Successful response without specific data or error response.">]>;
+export type SetDisplayNameResponse = v.InferOutput<typeof SetDisplayNameResponse>;
+import { type DeepImmutable } from "../_base.js";
+import { type ExchangeRequestConfig, type ExcludeErrorResponse, type ExtractRequestAction, type ExtractRequestOptions, type MultiSignRequestConfig } from "./_base/mod.js";
+/** Action parameters for the {@linkcode setDisplayName} function. */
+export type SetDisplayNameParameters = ExtractRequestAction<v.InferInput<typeof SetDisplayNameRequest>>;
+/** Request options for the {@linkcode setDisplayName} function. */
+export type SetDisplayNameOptions = ExtractRequestOptions<v.InferInput<typeof SetDisplayNameRequest>>;
+/** Successful variant of {@linkcode SetDisplayNameResponse} without errors. */
+export type SetDisplayNameSuccessResponse = ExcludeErrorResponse<SetDisplayNameResponse>;
+/**
+ * Set the display name in the leaderboard.
+ * @param config - General configuration for Exchange API requests.
+ * @param params - Parameters specific to the API request.
+ * @param opts - Request execution options.
+ * @returns Successful response without specific data.
+ *
+ * @throws {ApiRequestError} When the API returns an unsuccessful response.
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { setDisplayName } from "@nktkas/hyperliquid/api/exchange";
+ * import { privateKeyToAccount } from "npm:viem/accounts";
+ *
+ * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * await setDisplayName(
+ *   { transport, wallet },
+ *   { displayName: "..." },
+ * );
+ * ```
+ */
+export declare function setDisplayName(config: ExchangeRequestConfig | MultiSignRequestConfig, params: DeepImmutable<SetDisplayNameParameters>, opts?: SetDisplayNameOptions): Promise<SetDisplayNameSuccessResponse>;
+//# sourceMappingURL=setDisplayName.d.ts.map

package/esm/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,KAAK,CAAC,MAAM,SAAS,CAAC;AAS7B,+CAA+C;AAC/C,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,mEAAmE;AACnE,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;oEAK/B,CAAC;AACL,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAMlF,OAAO,EAAE,KAAK,aAAa,EAAU,MAAM,aAAa,CAAC;AACzD,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EAEzB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC5B,MAAM,gBAAgB,CAAC;AAExB,qEAAqE;AACrE,MAAM,MAAM,wBAAwB,GAAG,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC,CAAC;AAExG,mEAAmE;AACnE,MAAM,MAAM,qBAAqB,GAAG,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC,CAAC;AAEtG,+EAA+E;AAC/E,MAAM,MAAM,6BAA6B,GAAG,oBAAoB,CAAC,sBAAsB,CAAC,CAAC;AAEzF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;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,6BAA6B,CAAC,CAiBxC"}

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

@@ -0,0 +1,82 @@
+import * as v from "valibot";
+// ============================================================
+// API Schemas
+// ============================================================
+import { UnsignedInteger } from "../_base.js";
+import { ErrorResponse, Signature, SuccessResponse } from "./_base/mod.js";
+/** Set the display name in the leaderboard. */
+export const SetDisplayNameRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Action to perform. */
+        action: v.pipe(v.object({
+            /** Type of action. */
+            type: v.pipe(v.literal("setDisplayName"), v.description("Type of action.")),
+            /**
+             * Display name.
+             *
+             * Set to an empty string to remove the display name.
+             */
+            displayName: v.pipe(v.string(), v.description("Display name." +
+                "\n\nSet to an empty string to remove the display name.")),
+        }), v.description("Action to perform.")),
+        /** Unique request identifier (current timestamp in ms). */
+        nonce: v.pipe(UnsignedInteger, v.description("Unique request identifier (current timestamp in ms).")),
+        /** Cryptographic signature. */
+        signature: v.pipe(Signature, v.description("Cryptographic signature.")),
+        /** Expiration time of the action. */
+        expiresAfter: v.pipe(v.optional(UnsignedInteger), v.description("Expiration time of the action.")),
+    }), v.description("Set the display name in the leaderboard."));
+})();
+/** Successful response without specific data or error response. */
+export const SetDisplayNameResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.union([SuccessResponse, ErrorResponse]), v.description("Successful response without specific data or error response."));
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+import { parser } from "../_base.js";
+import { executeL1Action, } from "./_base/mod.js";
+/**
+ * Set the display name in the leaderboard.
+ * @param config - General configuration for Exchange API requests.
+ * @param params - Parameters specific to the API request.
+ * @param opts - Request execution options.
+ * @returns Successful response without specific data.
+ *
+ * @throws {ApiRequestError} When the API returns an unsuccessful response.
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { setDisplayName } from "@nktkas/hyperliquid/api/exchange";
+ * import { privateKeyToAccount } from "npm:viem/accounts";
+ *
+ * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * await setDisplayName(
+ *   { transport, wallet },
+ *   { displayName: "..." },
+ * );
+ * ```
+ */
+export async function setDisplayName(config, params, opts) {
+    const request = parser(SetDisplayNameRequest)({
+        action: {
+            type: "setDisplayName",
+            ...params,
+        },
+        nonce: 0, // Placeholder; actual nonce generated in `executeL1Action`
+        signature: {
+            r: "0x0000000000000000000000000000000000000000000000000000000000000000",
+            s: "0x0000000000000000000000000000000000000000000000000000000000000000",
+            v: 27,
+        },
+        expiresAfter: typeof config.defaultExpiresAfter === "number"
+            ? config.defaultExpiresAfter
+            : await config.defaultExpiresAfter?.(),
+    });
+    return await executeL1Action(config, request, opts?.signal);
+}
+//# sourceMappingURL=setDisplayName.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"setDisplayName.js","sourceRoot":"","sources":["../../../../src/src/api/exchange/setDisplayName.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAE3E,+CAA+C;AAC/C,MAAM,CAAC,MAAM,qBAAqB,GAAG,eAAe,CAAC,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;;;;eAIG;YACH,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CACX,eAAe;gBACb,wDAAwD,CAC3D,CACF;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,0CAA0C,CAAC,CAC1D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,mEAAmE;AACnE,MAAM,CAAC,MAAM,sBAAsB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC1D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK,CAAC,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC,EACzC,CAAC,CAAC,WAAW,CAAC,8DAA8D,CAAC,CAC9E,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,OAAO,EAAsB,MAAM,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EAGL,eAAe,GAIhB,MAAM,gBAAgB,CAAC;AAWxB;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAsD,EACtD,MAA+C,EAC/C,IAA4B;IAE5B,MAAM,OAAO,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;QAC5C,MAAM,EAAE;YACN,IAAI,EAAE,gBAAgB;YACtB,GAAG,MAAM;SACV;QACD,KAAK,EAAE,CAAC,EAAE,2DAA2D;QACrE,SAAS,EAAE;YACT,CAAC,EAAE,oEAAoE;YACvE,CAAC,EAAE,oEAAoE;YACvE,CAAC,EAAE,EAAE;SACN;QACD,YAAY,EAAE,OAAO,MAAM,CAAC,mBAAmB,KAAK,QAAQ;YAC1D,CAAC,CAAC,MAAM,CAAC,mBAAmB;YAC5B,CAAC,CAAC,MAAM,MAAM,CAAC,mBAAmB,EAAE,EAAE;KACzC,CAAC,CAAC;IACH,OAAO,MAAM,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;AAC9D,CAAC"}

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

@@ -0,0 +1,109 @@
+import * as v from "valibot";
+/** Set a referral code. */
+export declare const SetReferrerRequest: 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<"setReferrer", undefined>, v.DescriptionAction<"setReferrer", "Type of action.">]>;
+        /** Referral code. */
+        readonly code: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>, v.DescriptionAction<string, "Referral code.">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "setReferrer";
+        code: 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.NumberSchema<undefined>, v.IntegerAction<number, undefined>, 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.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.DescriptionAction<`0x${string}`, "Second 32-byte component of ECDSA signature.">]>;
+        readonly v: v.SchemaWithPipe<readonly [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.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, undefined>, v.DescriptionAction<number | undefined, "Expiration time of the action.">]>;
+}, undefined>, v.DescriptionAction<{
+    action: {
+        type: "setReferrer";
+        code: string;
+    };
+    nonce: number;
+    signature: {
+        r: `0x${string}`;
+        s: `0x${string}`;
+        v: 27 | 28;
+    };
+    expiresAfter?: number | undefined;
+}, "Set a referral code.">]>;
+export type SetReferrerRequest = v.InferOutput<typeof SetReferrerRequest>;
+/** Successful response without specific data or error response. */
+export declare const SetReferrerResponse: v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    readonly status: v.SchemaWithPipe<readonly [v.LiteralSchema<"ok", undefined>, v.DescriptionAction<"ok", "Successful status.">]>;
+    readonly response: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"default", undefined>, v.DescriptionAction<"default", "Type of response.">]>;
+    }, undefined>, v.DescriptionAction<{
+        type: "default";
+    }, "Response details.">]>;
+}, undefined>, v.DescriptionAction<{
+    status: "ok";
+    response: {
+        type: "default";
+    };
+}, "Successful response without specific data.">]>, v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    readonly status: v.SchemaWithPipe<readonly [v.LiteralSchema<"err", undefined>, v.DescriptionAction<"err", "Error status.">]>;
+    readonly response: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Error message.">]>;
+}, undefined>, v.DescriptionAction<{
+    status: "err";
+    response: string;
+}, "Error response for failed operations.">]>], undefined>, v.DescriptionAction<{
+    status: "err";
+    response: string;
+} | {
+    status: "ok";
+    response: {
+        type: "default";
+    };
+}, "Successful response without specific data or error response.">]>;
+export type SetReferrerResponse = v.InferOutput<typeof SetReferrerResponse>;
+import { type DeepImmutable } from "../_base.js";
+import { type ExchangeRequestConfig, type ExcludeErrorResponse, type ExtractRequestAction, type ExtractRequestOptions, type MultiSignRequestConfig } from "./_base/mod.js";
+/** Action parameters for the {@linkcode setReferrer} function. */
+export type SetReferrerParameters = ExtractRequestAction<v.InferInput<typeof SetReferrerRequest>>;
+/** Request options for the {@linkcode setReferrer} function. */
+export type SetReferrerOptions = ExtractRequestOptions<v.InferInput<typeof SetReferrerRequest>>;
+/** Successful variant of {@linkcode SetReferrerResponse} without errors. */
+export type SetReferrerSuccessResponse = ExcludeErrorResponse<SetReferrerResponse>;
+/**
+ * Set a referral code.
+ * @param config - General configuration for Exchange API requests.
+ * @param params - Parameters specific to the API request.
+ * @param opts - Request execution options.
+ * @returns Successful response without specific data.
+ *
+ * @throws {ApiRequestError} When the API returns an unsuccessful response.
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { setReferrer } from "@nktkas/hyperliquid/api/exchange";
+ * import { privateKeyToAccount } from "npm:viem/accounts";
+ *
+ * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * await setReferrer(
+ *   { transport, wallet },
+ *   { code: "..." },
+ * );
+ * ```
+ */
+export declare function setReferrer(config: ExchangeRequestConfig | MultiSignRequestConfig, params: DeepImmutable<SetReferrerParameters>, opts?: SetReferrerOptions): Promise<SetReferrerSuccessResponse>;
+//# sourceMappingURL=setReferrer.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"setReferrer.d.ts","sourceRoot":"","sources":["../../../../src/src/api/exchange/setReferrer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAS7B,2BAA2B;AAC3B,eAAO,MAAM,kBAAkB;IAGzB,yBAAyB;;QAGrB,sBAAsB;;QAKtB,qBAAqB;;;;;;IASzB,2DAA2D;;IAK3D,+BAA+B;;;;;;;;;;;;;;IAK/B,qCAAqC;;;;;;;;;;;;;;4BAQvC,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1E,mEAAmE;AACnE,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;oEAK5B,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAM5E,OAAO,EAAE,KAAK,aAAa,EAAU,MAAM,aAAa,CAAC;AACzD,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EAEzB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC5B,MAAM,gBAAgB,CAAC;AAExB,kEAAkE;AAClE,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,CAAC;AAElG,gEAAgE;AAChE,MAAM,MAAM,kBAAkB,GAAG,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,CAAC;AAEhG,4EAA4E;AAC5E,MAAM,MAAM,0BAA0B,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;AAEnF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;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,0BAA0B,CAAC,CAiBrC"}