@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.1

package/esm/src/api/info/spotClearinghouseState.js

@@ -0,0 +1,81 @@
+import * as v from "valibot";
+import { Address, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+// -------------------- Schemas --------------------
+/**
+ * Request spot clearinghouse state.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
+ */
+export const SpotClearinghouseStateRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("spotClearinghouseState"), v.description("Type of request.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+        /** DEX name (empty string for main dex). */
+        dex: v.pipe(v.optional(v.string()), v.description("DEX name (empty string for main dex).")),
+    }), v.description("Request spot clearinghouse state."));
+})();
+/**
+ * Account summary for spot trading.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
+ */
+export const SpotClearinghouseStateResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Balance for each token. */
+        balances: v.pipe(v.array(
+        /** Balance for a specific spot token. */
+        v.pipe(v.object({
+            /** Asset symbol. */
+            coin: v.pipe(v.string(), v.description("Asset symbol.")),
+            /** Unique identifier for the token. */
+            token: v.pipe(UnsignedInteger, v.description("Unique identifier for the token.")),
+            /** Total balance. */
+            total: v.pipe(UnsignedDecimal, v.description("Total balance.")),
+            /** Amount on hold. */
+            hold: v.pipe(UnsignedDecimal, v.description("Amount on hold.")),
+            /** Entry notional value. */
+            entryNtl: v.pipe(UnsignedDecimal, v.description("Entry notional value.")),
+        }), v.description("Balance for a specific spot token."))), v.description("Balance for each token.")),
+        /** Escrowed balances. */
+        evmEscrows: v.pipe(v.optional(v.array(
+        /** Escrowed balance for a specific asset. */
+        v.pipe(v.object({
+            /** Asset symbol. */
+            coin: v.pipe(v.string(), v.description("Asset symbol.")),
+            /** Unique identifier for the token. */
+            token: v.pipe(UnsignedInteger, v.description("Unique identifier for the token.")),
+            /** Total balance. */
+            total: v.pipe(UnsignedDecimal, v.description("Total balance.")),
+        }), v.description("Escrowed balance for a specific asset.")))), v.description("Escrowed balances.")),
+    }), v.description("Account summary for spot trading."));
+})();
+/**
+ * Request spot clearinghouse state.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Account summary for spot trading.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { spotClearinghouseState } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await spotClearinghouseState(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function spotClearinghouseState(config, params, signal) {
+    const request = parser(SpotClearinghouseStateRequest)({
+        type: "spotClearinghouseState",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=spotClearinghouseState.js.map

package/esm/src/api/info/spotClearinghouseState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spotClearinghouseState.js","sourceRoot":"","sources":["../../../../src/src/api/info/spotClearinghouseState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAsB,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAGtG,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACjE,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,EACnC,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,4CAA4C;QAC5C,GAAG,EAAE,CAAC,CAAC,IAAI,CACT,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,uCAAuC,CAAC,CACvD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,mCAAmC,CAAC,CACnD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAClE,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,8BAA8B;QAC9B,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,KAAK;QACL,yCAAyC;QACzC,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,oBAAoB;YACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;YACD,uCAAuC;YACvC,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;YACD,qBAAqB;YACrB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;YACD,sBAAsB;YACtB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;YACD,4BAA4B;YAC5B,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oCAAoC,CAAC,CACpD,CACF,EACD,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;QACD,yBAAyB;QACzB,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,QAAQ,CACR,CAAC,CAAC,KAAK;QACL,6CAA6C;QAC7C,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,oBAAoB;YACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;YACD,uCAAuC;YACvC,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;YACD,qBAAqB;YACrB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,wCAAwC,CAAC,CACxD,CACF,CACF,EACD,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,mCAAmC,CAAC,CACnD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,sBAAsB,CACpC,MAAyB,EACzB,MAAuD,EACvD,MAAoB;IAEpB,MAAM,OAAO,GAAG,MAAM,CAAC,6BAA6B,CAAC,CAAC;QACpD,IAAI,EAAE,wBAAwB;QAC9B,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

package/esm/src/api/info/spotDeployState.d.ts

@@ -0,0 +1,162 @@
+import * as v from "valibot";
+import { type DeepImmutable } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * Request spot deploy state.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
+ */
+export declare const SpotDeployStateRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"spotDeployState", undefined>, v.DescriptionAction<"spotDeployState", "Type of request.">]>;
+    /** User address. */
+    readonly user: 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}`, "User address.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "spotDeployState";
+    user: `0x${string}`;
+}, "Request spot deploy state.">]>;
+export type SpotDeployStateRequest = v.InferOutput<typeof SpotDeployStateRequest>;
+/**
+ * Deploy state for spot tokens.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
+ */
+export declare const SpotDeployStateResponse: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Array of deploy states for tokens. */
+    readonly states: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Token ID. */
+        readonly token: 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, "Token ID.">]>;
+        /** Token specification. */
+        readonly spec: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+            /** Name of the token. */
+            readonly name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Name of the token.">]>;
+            /** Minimum decimal places for order sizes. */
+            readonly szDecimals: 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, "Minimum decimal places for order sizes.">]>;
+            /** Number of decimals for the token's smallest unit. */
+            readonly weiDecimals: 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, "Number of decimals for the token's smallest unit.">]>;
+        }, undefined>, v.DescriptionAction<{
+            name: string;
+            szDecimals: number;
+            weiDecimals: number;
+        }, "Token specification.">]>;
+        /** Full name of the token. */
+        readonly fullName: v.SchemaWithPipe<readonly [v.NullableSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | null, "Full name of the token.">]>;
+        /** Deployer trading fee share for the token. */
+        readonly deployerTradingFeeShare: 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, "Deployer trading fee share for the token.">]>;
+        /** Spot indices for the token. */
+        readonly spots: v.SchemaWithPipe<readonly [v.ArraySchema<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[], "Spot indices for the token.">]>;
+        /** Maximum supply of the token. */
+        readonly maxSupply: v.SchemaWithPipe<readonly [v.NullableSchema<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>]>, undefined>, v.DescriptionAction<string | null, "Maximum supply of the token.">]>;
+        /** Hyperliquidity genesis balance of the token. */
+        readonly hyperliquidityGenesisBalance: 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, "Hyperliquidity genesis balance of the token.">]>;
+        /** Total genesis balance (in wei) for the token. */
+        readonly totalGenesisBalanceWei: 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, "Total genesis balance (in wei) for the token.">]>;
+        /** User genesis balances for the token. */
+        readonly userGenesisBalances: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[`0x${string}`, string][], "User genesis balances for the token.">]>;
+        /** Existing token genesis balances for the token. */
+        readonly existingTokenGenesisBalances: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.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>]>], undefined>, undefined>, v.DescriptionAction<[number, string][], "Existing token genesis balances for the token.">]>;
+        /** Blacklisted users for the token. */
+        readonly blacklistUsers: v.SchemaWithPipe<readonly [v.ArraySchema<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}`[], "Blacklisted users for the token.">]>;
+    }, undefined>, v.DescriptionAction<{
+        token: number;
+        spec: {
+            name: string;
+            szDecimals: number;
+            weiDecimals: number;
+        };
+        fullName: string | null;
+        deployerTradingFeeShare: string;
+        spots: number[];
+        maxSupply: string | null;
+        hyperliquidityGenesisBalance: string;
+        totalGenesisBalanceWei: string;
+        userGenesisBalances: [`0x${string}`, string][];
+        existingTokenGenesisBalances: [number, string][];
+        blacklistUsers: `0x${string}`[];
+    }, "Deploy state for a specific token.">]>, undefined>, v.DescriptionAction<{
+        token: number;
+        spec: {
+            name: string;
+            szDecimals: number;
+            weiDecimals: number;
+        };
+        fullName: string | null;
+        deployerTradingFeeShare: string;
+        spots: number[];
+        maxSupply: string | null;
+        hyperliquidityGenesisBalance: string;
+        totalGenesisBalanceWei: string;
+        userGenesisBalances: [`0x${string}`, string][];
+        existingTokenGenesisBalances: [number, string][];
+        blacklistUsers: `0x${string}`[];
+    }[], "Array of deploy states for tokens.">]>;
+    /** Status of the deploy auction. */
+    readonly gasAuction: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Current gas. */
+        readonly currentGas: v.SchemaWithPipe<readonly [v.NullableSchema<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>]>, undefined>, v.DescriptionAction<string | null, "Current gas.">]>;
+        /** Duration in seconds. */
+        readonly durationSeconds: 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, "Duration in seconds.">]>;
+        /** Ending gas. */
+        readonly endGas: v.SchemaWithPipe<readonly [v.NullableSchema<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>]>, undefined>, v.DescriptionAction<string | null, "Ending gas.">]>;
+        /** Starting gas. */
+        readonly startGas: 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, "Starting gas.">]>;
+        /** Auction start time (seconds since epoch). */
+        readonly startTimeSeconds: 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, "Auction start time (seconds since epoch).">]>;
+    }, undefined>, v.DescriptionAction<{
+        currentGas: string | null;
+        durationSeconds: number;
+        endGas: string | null;
+        startGas: string;
+        startTimeSeconds: number;
+    }, "Status of the deploy auction.">]>;
+}, undefined>, v.DescriptionAction<{
+    states: {
+        token: number;
+        spec: {
+            name: string;
+            szDecimals: number;
+            weiDecimals: number;
+        };
+        fullName: string | null;
+        deployerTradingFeeShare: string;
+        spots: number[];
+        maxSupply: string | null;
+        hyperliquidityGenesisBalance: string;
+        totalGenesisBalanceWei: string;
+        userGenesisBalances: [`0x${string}`, string][];
+        existingTokenGenesisBalances: [number, string][];
+        blacklistUsers: `0x${string}`[];
+    }[];
+    gasAuction: {
+        currentGas: string | null;
+        durationSeconds: number;
+        endGas: string | null;
+        startGas: string;
+        startTimeSeconds: number;
+    };
+}, "Deploy state for spot tokens.">]>;
+export type SpotDeployStateResponse = v.InferOutput<typeof SpotDeployStateResponse>;
+/** Request parameters for the {@linkcode spotDeployState} function. */
+export type SpotDeployStateParameters = Omit<v.InferInput<typeof SpotDeployStateRequest>, "type">;
+/**
+ * Request spot deploy state.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Deploy state for spot tokens.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { spotDeployState } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await spotDeployState(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export declare function spotDeployState(config: InfoRequestConfig, params: DeepImmutable<SpotDeployStateParameters>, signal?: AbortSignal): Promise<SpotDeployStateResponse>;
+//# sourceMappingURL=spotDeployState.d.ts.map

package/esm/src/api/info/spotDeployState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spotDeployState.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/spotDeployState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAW,KAAK,aAAa,EAA4C,MAAM,eAAe,CAAC;AACtG,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,sBAAsB;IAG7B,uBAAuB;;IAKvB,oBAAoB;;;;;kCAQtB,CAAC;AACL,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAElF;;;GAGG;AACH,eAAO,MAAM,uBAAuB;IAG9B,yCAAyC;;QAMjC,gBAAgB;;QAKhB,2BAA2B;;YAGvB,yBAAyB;;YAKzB,8CAA8C;;YAK9C,wDAAwD;;;;;;;QAQ5D,8BAA8B;;QAK9B,gDAAgD;;QAKhD,kCAAkC;;QAKlC,mCAAmC;;QAKnC,mDAAmD;;QAKnD,oDAAoD;;QAKpD,2CAA2C;;QAK3C,qDAAqD;;QAKrD,uCAAuC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAW/C,oCAAoC;;QAGhC,mBAAmB;;QAKnB,2BAA2B;;QAK3B,kBAAkB;;QAKlB,oBAAoB;;QAKpB,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qCAWtD,CAAC;AACL,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAIpF,uEAAuE;AACvE,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,sBAAsB,CAAC,EAAE,MAAM,CAAC,CAAC;AAElG;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,yBAAyB,CAAC,EAChD,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,uBAAuB,CAAC,CAMlC"}

package/esm/src/api/info/spotDeployState.js

@@ -0,0 +1,100 @@
+import * as v from "valibot";
+import { Address, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+// -------------------- Schemas --------------------
+/**
+ * Request spot deploy state.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
+ */
+export const SpotDeployStateRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("spotDeployState"), v.description("Type of request.")),
+        /** User address. */
+        user: v.pipe(Address, v.description("User address.")),
+    }), v.description("Request spot deploy state."));
+})();
+/**
+ * Deploy state for spot tokens.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
+ */
+export const SpotDeployStateResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Array of deploy states for tokens. */
+        states: v.pipe(v.array(
+        /** Deploy state for a specific token. */
+        v.pipe(v.object({
+            /** Token ID. */
+            token: v.pipe(UnsignedInteger, v.description("Token ID.")),
+            /** Token specification. */
+            spec: v.pipe(v.object({
+                /** Name of the token. */
+                name: v.pipe(v.string(), v.description("Name of the token.")),
+                /** Minimum decimal places for order sizes. */
+                szDecimals: v.pipe(UnsignedInteger, v.description("Minimum decimal places for order sizes.")),
+                /** Number of decimals for the token's smallest unit. */
+                weiDecimals: v.pipe(UnsignedInteger, v.description("Number of decimals for the token's smallest unit.")),
+            }), v.description("Token specification.")),
+            /** Full name of the token. */
+            fullName: v.pipe(v.nullable(v.string()), v.description("Full name of the token.")),
+            /** Deployer trading fee share for the token. */
+            deployerTradingFeeShare: v.pipe(UnsignedDecimal, v.description("Deployer trading fee share for the token.")),
+            /** Spot indices for the token. */
+            spots: v.pipe(v.array(UnsignedInteger), v.description("Spot indices for the token.")),
+            /** Maximum supply of the token. */
+            maxSupply: v.pipe(v.nullable(UnsignedDecimal), v.description("Maximum supply of the token.")),
+            /** Hyperliquidity genesis balance of the token. */
+            hyperliquidityGenesisBalance: v.pipe(UnsignedDecimal, v.description("Hyperliquidity genesis balance of the token.")),
+            /** Total genesis balance (in wei) for the token. */
+            totalGenesisBalanceWei: v.pipe(UnsignedDecimal, v.description("Total genesis balance (in wei) for the token.")),
+            /** User genesis balances for the token. */
+            userGenesisBalances: v.pipe(v.array(v.tuple([Address, UnsignedDecimal])), v.description("User genesis balances for the token.")),
+            /** Existing token genesis balances for the token. */
+            existingTokenGenesisBalances: v.pipe(v.array(v.tuple([UnsignedInteger, UnsignedDecimal])), v.description("Existing token genesis balances for the token.")),
+            /** Blacklisted users for the token. */
+            blacklistUsers: v.pipe(v.array(Address), v.description("Blacklisted users for the token.")),
+        }), v.description("Deploy state for a specific token."))), v.description("Array of deploy states for tokens.")),
+        /** Status of the deploy auction. */
+        gasAuction: v.pipe(v.object({
+            /** Current gas. */
+            currentGas: v.pipe(v.nullable(UnsignedDecimal), v.description("Current gas.")),
+            /** Duration in seconds. */
+            durationSeconds: v.pipe(UnsignedInteger, v.description("Duration in seconds.")),
+            /** Ending gas. */
+            endGas: v.pipe(v.nullable(UnsignedDecimal), v.description("Ending gas.")),
+            /** Starting gas. */
+            startGas: v.pipe(UnsignedDecimal, v.description("Starting gas.")),
+            /** Auction start time (seconds since epoch). */
+            startTimeSeconds: v.pipe(UnsignedInteger, v.description("Auction start time (seconds since epoch).")),
+        }), v.description("Status of the deploy auction.")),
+    }), v.description("Deploy state for spot tokens."));
+})();
+/**
+ * Request spot deploy state.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Deploy state for spot tokens.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-the-spot-deploy-auction
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { spotDeployState } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await spotDeployState(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function spotDeployState(config, params, signal) {
+    const request = parser(SpotDeployStateRequest)({
+        type: "spotDeployState",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=spotDeployState.js.map

package/esm/src/api/info/spotDeployState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spotDeployState.js","sourceRoot":"","sources":["../../../../src/src/api/info/spotDeployState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAsB,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAGtG,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC1D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAC5B,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IAC3D,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,yCAAyC;QACzC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,KAAK;QACL,yCAAyC;QACzC,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,gBAAgB;YAChB,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAC3B;YACD,2BAA2B;YAC3B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,CAAC;gBACP,yBAAyB;gBACzB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;gBACD,8CAA8C;gBAC9C,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,yCAAyC,CAAC,CACzD;gBACD,wDAAwD;gBACxD,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,mDAAmD,CAAC,CACnE;aACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;YACD,8BAA8B;YAC9B,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;YACD,gDAAgD;YAChD,uBAAuB,EAAE,CAAC,CAAC,IAAI,CAC7B,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAC3D;YACD,kCAAkC;YAClC,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,EACxB,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C;YACD,mCAAmC;YACnC,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;YACD,mDAAmD;YACnD,4BAA4B,EAAE,CAAC,CAAC,IAAI,CAClC,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,8CAA8C,CAAC,CAC9D;YACD,oDAAoD;YACpD,sBAAsB,EAAE,CAAC,CAAC,IAAI,CAC5B,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,+CAA+C,CAAC,CAC/D;YACD,2CAA2C;YAC3C,mBAAmB,EAAE,CAAC,CAAC,IAAI,CACzB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC,EAC5C,CAAC,CAAC,WAAW,CAAC,sCAAsC,CAAC,CACtD;YACD,qDAAqD;YACrD,4BAA4B,EAAE,CAAC,CAAC,IAAI,CAClC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC,CAAC,EACpD,CAAC,CAAC,WAAW,CAAC,gDAAgD,CAAC,CAChE;YACD,uCAAuC;YACvC,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,EAChB,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,oCAAoC,CAAC,CACpD,CACF,EACD,CAAC,CAAC,WAAW,CAAC,oCAAoC,CAAC,CACpD;QACD,oCAAoC;QACpC,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,MAAM,CAAC;YACP,mBAAmB;YACnB,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;YACD,2BAA2B;YAC3B,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC;YACD,kBAAkB;YAClB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAC7B;YACD,oBAAoB;YACpB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;YACD,gDAAgD;YAChD,gBAAgB,EAAE,CAAC,CAAC,IAAI,CACtB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAC3D;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,eAAe,CAC7B,MAAyB,EACzB,MAAgD,EAChD,MAAoB;IAEpB,MAAM,OAAO,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC;QAC7C,IAAI,EAAE,iBAAiB;QACvB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

package/esm/src/api/info/spotMeta.d.ts

@@ -0,0 +1,137 @@
+import * as v from "valibot";
+import type { InfoRequestConfig } from "./_common.js";
+/**
+ * Request spot trading metadata.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
+ */
+export declare const SpotMetaRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"spotMeta", undefined>, v.DescriptionAction<"spotMeta", "Type of request.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "spotMeta";
+}, "Request spot trading metadata.">]>;
+export type SpotMetaRequest = v.InferOutput<typeof SpotMetaRequest>;
+/**
+ * Metadata for spot assets.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
+ */
+export declare const SpotMetaResponse: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Trading universes available for spot trading. */
+    readonly universe: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Token indices included in this universe. */
+        readonly tokens: v.SchemaWithPipe<readonly [v.ArraySchema<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[], "Token indices included in this universe.">]>;
+        /** Name of the universe. */
+        readonly name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Name of the universe.">]>;
+        /** Unique identifier of the universe. */
+        readonly index: 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 identifier of the universe.">]>;
+        /** Indicates if the token is the primary representation in the system. */
+        readonly isCanonical: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates if the token is the primary representation in the system.">]>;
+    }, undefined>, v.DescriptionAction<{
+        tokens: number[];
+        name: string;
+        index: number;
+        isCanonical: boolean;
+    }, "Trading universe details.">]>, undefined>, v.DescriptionAction<{
+        tokens: number[];
+        name: string;
+        index: number;
+        isCanonical: boolean;
+    }[], "Trading universes available for spot trading.">]>;
+    /** Tokens available for spot trading. */
+    readonly tokens: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Name of the token. */
+        readonly name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Name of the token.">]>;
+        /** Minimum decimal places for order sizes. */
+        readonly szDecimals: 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, "Minimum decimal places for order sizes.">]>;
+        /** Number of decimals for the token's smallest unit. */
+        readonly weiDecimals: 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, "Number of decimals for the token's smallest unit.">]>;
+        /** Unique identifier for the token. */
+        readonly index: 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 identifier for the token.">]>;
+        /** Token ID. */
+        readonly tokenId: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.DescriptionAction<`0x${string}`, "Token ID.">]>;
+        /** Indicates if the token is the primary representation in the system. */
+        readonly isCanonical: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates if the token is the primary representation in the system.">]>;
+        /** EVM contract details. */
+        readonly evmContract: v.SchemaWithPipe<readonly [v.NullableSchema<v.ObjectSchema<{
+            /** Contract address. */
+            readonly address: 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}`, "Contract address.">]>;
+            /** Extra decimals in the token's smallest unit. */
+            readonly evm_extra_wei_decimals: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>]>, v.DescriptionAction<number, "Extra decimals in the token's smallest unit.">]>;
+        }, undefined>, undefined>, v.DescriptionAction<{
+            address: `0x${string}`;
+            evm_extra_wei_decimals: number;
+        } | null, "EVM contract details.">]>;
+        /** Full display name of the token. */
+        readonly fullName: v.SchemaWithPipe<readonly [v.NullableSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | null, "Full display name of the token.">]>;
+        /** Deployer trading fee share for the token. */
+        readonly deployerTradingFeeShare: 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, "Deployer trading fee share for the token.">]>;
+    }, undefined>, v.DescriptionAction<{
+        name: string;
+        szDecimals: number;
+        weiDecimals: number;
+        index: number;
+        tokenId: `0x${string}`;
+        isCanonical: boolean;
+        evmContract: {
+            address: `0x${string}`;
+            evm_extra_wei_decimals: number;
+        } | null;
+        fullName: string | null;
+        deployerTradingFeeShare: string;
+    }, "Spot token details.">]>, undefined>, v.DescriptionAction<{
+        name: string;
+        szDecimals: number;
+        weiDecimals: number;
+        index: number;
+        tokenId: `0x${string}`;
+        isCanonical: boolean;
+        evmContract: {
+            address: `0x${string}`;
+            evm_extra_wei_decimals: number;
+        } | null;
+        fullName: string | null;
+        deployerTradingFeeShare: string;
+    }[], "Tokens available for spot trading.">]>;
+}, undefined>, v.DescriptionAction<{
+    universe: {
+        tokens: number[];
+        name: string;
+        index: number;
+        isCanonical: boolean;
+    }[];
+    tokens: {
+        name: string;
+        szDecimals: number;
+        weiDecimals: number;
+        index: number;
+        tokenId: `0x${string}`;
+        isCanonical: boolean;
+        evmContract: {
+            address: `0x${string}`;
+            evm_extra_wei_decimals: number;
+        } | null;
+        fullName: string | null;
+        deployerTradingFeeShare: string;
+    }[];
+}, "Metadata for spot assets.">]>;
+export type SpotMetaResponse = v.InferOutput<typeof SpotMetaResponse>;
+/**
+ * Request spot trading metadata.
+ * @param config - General configuration for Info API requests.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Metadata for spot assets.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { spotMeta } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await spotMeta({ transport });
+ * ```
+ */
+export declare function spotMeta(config: InfoRequestConfig, signal?: AbortSignal): Promise<SpotMetaResponse>;
+//# sourceMappingURL=spotMeta.d.ts.map

package/esm/src/api/info/spotMeta.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spotMeta.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/spotMeta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAItD;;;GAGG;AACH,eAAO,MAAM,eAAe;IAGtB,uBAAuB;;;;sCAQzB,CAAC;AACL,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEpE;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAGvB,oDAAoD;;QAM5C,+CAA+C;;QAK/C,4BAA4B;;QAK5B,yCAAyC;;QAKzC,0EAA0E;;;;;;;;;;;;;IAWlF,yCAAyC;;QAMjC,yBAAyB;;QAKzB,8CAA8C;;QAK9C,wDAAwD;;QAKxD,uCAAuC;;QAKvC,gBAAgB;;QAKhB,0EAA0E;;QAK1E,4BAA4B;;YAItB,wBAAwB;;YAKxB,mDAAmD;;;;;;QASzD,sCAAsC;;QAKtC,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCAc1D,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAItE;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,iBAAiB,EACzB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,gBAAgB,CAAC,CAK3B"}

package/esm/src/api/info/spotMeta.js

@@ -0,0 +1,88 @@
+import * as v from "valibot";
+import { Address, Hex, Integer, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+// -------------------- Schemas --------------------
+/**
+ * Request spot trading metadata.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
+ */
+export const SpotMetaRequest = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("spotMeta"), v.description("Type of request.")),
+    }), v.description("Request spot trading metadata."));
+})();
+/**
+ * Metadata for spot assets.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
+ */
+export const SpotMetaResponse = /* @__PURE__ */ (() => {
+    return v.pipe(v.object({
+        /** Trading universes available for spot trading. */
+        universe: v.pipe(v.array(
+        /** Trading universe details. */
+        v.pipe(v.object({
+            /** Token indices included in this universe. */
+            tokens: v.pipe(v.array(UnsignedInteger), v.description("Token indices included in this universe.")),
+            /** Name of the universe. */
+            name: v.pipe(v.string(), v.description("Name of the universe.")),
+            /** Unique identifier of the universe. */
+            index: v.pipe(UnsignedInteger, v.description("Unique identifier of the universe.")),
+            /** Indicates if the token is the primary representation in the system. */
+            isCanonical: v.pipe(v.boolean(), v.description("Indicates if the token is the primary representation in the system.")),
+        }), v.description("Trading universe details."))), v.description("Trading universes available for spot trading.")),
+        /** Tokens available for spot trading. */
+        tokens: v.pipe(v.array(
+        /** Spot token details. */
+        v.pipe(v.object({
+            /** Name of the token. */
+            name: v.pipe(v.string(), v.description("Name of the token.")),
+            /** Minimum decimal places for order sizes. */
+            szDecimals: v.pipe(UnsignedInteger, v.description("Minimum decimal places for order sizes.")),
+            /** Number of decimals for the token's smallest unit. */
+            weiDecimals: v.pipe(UnsignedInteger, v.description("Number of decimals for the token's smallest unit.")),
+            /** Unique identifier for the token. */
+            index: v.pipe(UnsignedInteger, v.description("Unique identifier for the token.")),
+            /** Token ID. */
+            tokenId: v.pipe(Hex, v.description("Token ID.")),
+            /** Indicates if the token is the primary representation in the system. */
+            isCanonical: v.pipe(v.boolean(), v.description("Indicates if the token is the primary representation in the system.")),
+            /** EVM contract details. */
+            evmContract: v.pipe(v.nullable(v.object({
+                /** Contract address. */
+                address: v.pipe(Address, v.description("Contract address.")),
+                /** Extra decimals in the token's smallest unit. */
+                evm_extra_wei_decimals: v.pipe(Integer, v.description("Extra decimals in the token's smallest unit.")),
+            })), v.description("EVM contract details.")),
+            /** Full display name of the token. */
+            fullName: v.pipe(v.nullable(v.string()), v.description("Full display name of the token.")),
+            /** Deployer trading fee share for the token. */
+            deployerTradingFeeShare: v.pipe(UnsignedDecimal, v.description("Deployer trading fee share for the token.")),
+        }), v.description("Spot token details."))), v.description("Tokens available for spot trading.")),
+    }), v.description("Metadata for spot assets."));
+})();
+// -------------------- Function --------------------
+/**
+ * Request spot trading metadata.
+ * @param config - General configuration for Info API requests.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Metadata for spot assets.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-metadata
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { spotMeta } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await spotMeta({ transport });
+ * ```
+ */
+export function spotMeta(config, signal) {
+    const request = parser(SpotMetaRequest)({
+        type: "spotMeta",
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=spotMeta.js.map

package/esm/src/api/info/spotMeta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spotMeta.js","sourceRoot":"","sources":["../../../../src/src/api/info/spotMeta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAGhG,oDAAoD;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACnD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EACrB,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC,CAAC,GAAG,EAAE;IACpD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,oDAAoD;QACpD,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,KAAK;QACL,gCAAgC;QAChC,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,+CAA+C;YAC/C,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,EACxB,CAAC,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAC1D;YACD,4BAA4B;YAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;YACD,yCAAyC;YACzC,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,oCAAoC,CAAC,CACpD;YACD,0EAA0E;YAC1E,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,qEAAqE,CAAC,CACrF;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C,CACF,EACD,CAAC,CAAC,WAAW,CAAC,+CAA+C,CAAC,CAC/D;QACD,yCAAyC;QACzC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,KAAK;QACL,0BAA0B;QAC1B,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,yBAAyB;YACzB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;YACD,8CAA8C;YAC9C,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,yCAAyC,CAAC,CACzD;YACD,wDAAwD;YACxD,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,mDAAmD,CAAC,CACnE;YACD,uCAAuC;YACvC,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;YACD,gBAAgB;YAChB,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,GAAG,EACH,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAC3B;YACD,0EAA0E;YAC1E,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,CAAC,CAAC,OAAO,EAAE,EACX,CAAC,CAAC,WAAW,CAAC,qEAAqE,CAAC,CACrF;YACD,4BAA4B;YAC5B,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,CAAC,CAAC,QAAQ,CACR,CAAC,CAAC,MAAM,CAAC;gBACP,wBAAwB;gBACxB,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;gBACD,mDAAmD;gBACnD,sBAAsB,EAAE,CAAC,CAAC,IAAI,CAC5B,OAAO,EACP,CAAC,CAAC,WAAW,CAAC,8CAA8C,CAAC,CAC9D;aACF,CAAC,CACH,EACD,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;YACD,sCAAsC;YACtC,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,iCAAiC,CAAC,CACjD;YACD,gDAAgD;YAChD,uBAAuB,EAAE,CAAC,CAAC,IAAI,CAC7B,eAAe,EACf,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAC3D;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,qBAAqB,CAAC,CACrC,CACF,EACD,CAAC,CAAC,WAAW,CAAC,oCAAoC,CAAC,CACpD;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,qDAAqD;AAErD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,QAAQ,CACtB,MAAyB,EACzB,MAAoB;IAEpB,MAAM,OAAO,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC;QACtC,IAAI,EAAE,UAAU;KACjB,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}