@hfunlabs/hyperliquid 0.27.1-hfunlabs.1

package/script/src/api/info/tokenDetails.d.ts

@@ -0,0 +1,114 @@
+import * as v from "valibot";
+/**
+ * Request token details.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
+ */
+export declare const TokenDetailsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"tokenDetails", undefined>, v.DescriptionAction<"tokenDetails", "Type of request.">]>;
+    /** Token ID. */
+    readonly tokenId: 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}`, 34, undefined>]>, v.DescriptionAction<`0x${string}`, "Token ID.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "tokenDetails";
+    tokenId: `0x${string}`;
+}, "Request token details.">]>;
+export type TokenDetailsRequest = v.InferOutput<typeof TokenDetailsRequest>;
+/**
+ * Details of a token.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
+ */
+export declare const TokenDetailsResponse: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Name of the token. */
+    readonly name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Name of the token.">]>;
+    /** Maximum supply of the token. */
+    readonly maxSupply: 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, "Maximum supply of the token.">]>;
+    /** Total supply of the token. */
+    readonly totalSupply: 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, "Total supply of the token.">]>;
+    /** Circulating supply of the token. */
+    readonly circulatingSupply: 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, "Circulating supply of the token.">]>;
+    /** Decimal places for the minimum tradable unit. */
+    readonly szDecimals: 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, "Decimal places for the minimum tradable unit.">]>;
+    /** Decimal places 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.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Decimal places for the token's smallest unit.">]>;
+    /** Mid price of the token. */
+    readonly midPx: 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, "Mid price of the token.">]>;
+    /** Mark price of the token. */
+    readonly markPx: 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, "Mark price of the token.">]>;
+    /** Previous day's price of the token. */
+    readonly prevDayPx: 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, "Previous day's price of the token.">]>;
+    /** Genesis data for the token. */
+    readonly genesis: v.SchemaWithPipe<readonly [v.NullableSchema<v.ObjectSchema<{
+        /** User balances. */
+        readonly userBalances: 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.StringSchema<undefined>], undefined>, undefined>, v.DescriptionAction<[`0x${string}`, string][], "User balances.">]>;
+        /** Existing token balances. */
+        readonly existingTokenBalances: v.SchemaWithPipe<readonly [v.ArraySchema<v.TupleSchema<[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.StringSchema<undefined>], undefined>, undefined>, v.DescriptionAction<[number, string][], "Existing token balances.">]>;
+        /** Blacklisted users. */
+        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.">]>;
+    }, undefined>, undefined>, v.DescriptionAction<{
+        userBalances: [`0x${string}`, string][];
+        existingTokenBalances: [number, string][];
+        blacklistUsers: `0x${string}`[];
+    } | null, "Genesis data for the token.">]>;
+    /** Deployer address. */
+    readonly deployer: v.SchemaWithPipe<readonly [v.NullableSchema<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}` | null, "Deployer address.">]>;
+    /** Gas used during token deployment. */
+    readonly deployGas: v.SchemaWithPipe<readonly [v.NullableSchema<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>]>, undefined>, v.DescriptionAction<string | null, "Gas used during token deployment.">]>;
+    /** Deployment time. */
+    readonly deployTime: v.SchemaWithPipe<readonly [v.NullableSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | null, "Deployment time.">]>;
+    /** Seeded USDC amount for the token. */
+    readonly seededUsdc: 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, "Seeded USDC amount for the token.">]>;
+    /** Non-circulating user balances of the token. */
+    readonly nonCirculatingUserBalances: 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.StringSchema<undefined>], undefined>, undefined>, v.DescriptionAction<[`0x${string}`, string][], "Non-circulating user balances of the token.">]>;
+    /** Future emissions amount. */
+    readonly futureEmissions: 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, "Future emissions amount.">]>;
+}, undefined>, v.DescriptionAction<{
+    name: string;
+    maxSupply: string;
+    totalSupply: string;
+    circulatingSupply: string;
+    szDecimals: number;
+    weiDecimals: number;
+    midPx: string;
+    markPx: string;
+    prevDayPx: string;
+    genesis: {
+        userBalances: [`0x${string}`, string][];
+        existingTokenBalances: [number, string][];
+        blacklistUsers: `0x${string}`[];
+    } | null;
+    deployer: `0x${string}` | null;
+    deployGas: string | null;
+    deployTime: string | null;
+    seededUsdc: string;
+    nonCirculatingUserBalances: [`0x${string}`, string][];
+    futureEmissions: string;
+}, "Details of a token.">]>;
+export type TokenDetailsResponse = v.InferOutput<typeof TokenDetailsResponse>;
+import { type DeepImmutable } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+/** Request parameters for the {@linkcode tokenDetails} function. */
+export type TokenDetailsParameters = Omit<v.InferInput<typeof TokenDetailsRequest>, "type">;
+/**
+ * Request token details.
+ * @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 Details of a token.
+ *
+ * @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-a-token
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { tokenDetails } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await tokenDetails(
+ *   { transport },
+ *   { tokenId: "0x..." },
+ * );
+ * ```
+ */
+export declare function tokenDetails(config: InfoRequestConfig, params: DeepImmutable<TokenDetailsParameters>, signal?: AbortSignal): Promise<TokenDetailsResponse>;
+//# sourceMappingURL=tokenDetails.d.ts.map

package/script/src/api/info/tokenDetails.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenDetails.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/tokenDetails.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,eAAO,MAAM,mBAAmB;IAG1B,uBAAuB;;IAKvB,gBAAgB;;;;;8BAQlB,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE5E;;;GAGG;AACH,eAAO,MAAM,oBAAoB;IAG3B,yBAAyB;;IAKzB,mCAAmC;;IAKnC,iCAAiC;;IAKjC,uCAAuC;;IAKvC,oDAAoD;;IAKpD,oDAAoD;;IAKpD,8BAA8B;;IAK9B,+BAA+B;;IAK/B,yCAAyC;;IAKzC,kCAAkC;;QAI5B,qBAAqB;;QAKrB,+BAA+B;;QAK/B,yBAAyB;;;;;;;IAS/B,wBAAwB;;IAKxB,wCAAwC;;IAKxC,uBAAuB;;IAKvB,wCAAwC;;IAKxC,kDAAkD;;IAKlD,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;2BAQjC,CAAC;AACL,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAM9E,OAAO,EAAE,KAAK,aAAa,EAAU,MAAM,aAAa,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAErD,oEAAoE;AACpE,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,mBAAmB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,sBAAsB,CAAC,EAC7C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,oBAAoB,CAAC,CAM/B"}

package/script/src/api/info/tokenDetails.js

@@ -0,0 +1,135 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TokenDetailsResponse = exports.TokenDetailsRequest = void 0;
+exports.tokenDetails = tokenDetails;
+const v = __importStar(require("valibot"));
+// ============================================================
+// API Schemas
+// ============================================================
+const _base_js_1 = require("../_base.js");
+/**
+ * Request token details.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
+ */
+exports.TokenDetailsRequest = (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("tokenDetails"), v.description("Type of request.")),
+        /** Token ID. */
+        tokenId: v.pipe(v.pipe(_base_js_1.Hex, v.length(34)), v.description("Token ID.")),
+    }), v.description("Request token details."));
+})();
+/**
+ * Details of a token.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-information-about-a-token
+ */
+exports.TokenDetailsResponse = (() => {
+    return v.pipe(v.object({
+        /** Name of the token. */
+        name: v.pipe(v.string(), v.description("Name of the token.")),
+        /** Maximum supply of the token. */
+        maxSupply: v.pipe(_base_js_1.UnsignedDecimal, v.description("Maximum supply of the token.")),
+        /** Total supply of the token. */
+        totalSupply: v.pipe(_base_js_1.UnsignedDecimal, v.description("Total supply of the token.")),
+        /** Circulating supply of the token. */
+        circulatingSupply: v.pipe(_base_js_1.UnsignedDecimal, v.description("Circulating supply of the token.")),
+        /** Decimal places for the minimum tradable unit. */
+        szDecimals: v.pipe(_base_js_1.UnsignedInteger, v.description("Decimal places for the minimum tradable unit.")),
+        /** Decimal places for the token's smallest unit. */
+        weiDecimals: v.pipe(_base_js_1.UnsignedInteger, v.description("Decimal places for the token's smallest unit.")),
+        /** Mid price of the token. */
+        midPx: v.pipe(_base_js_1.UnsignedDecimal, v.description("Mid price of the token.")),
+        /** Mark price of the token. */
+        markPx: v.pipe(_base_js_1.UnsignedDecimal, v.description("Mark price of the token.")),
+        /** Previous day's price of the token. */
+        prevDayPx: v.pipe(_base_js_1.UnsignedDecimal, v.description("Previous day's price of the token.")),
+        /** Genesis data for the token. */
+        genesis: v.pipe(v.nullable(v.object({
+            /** User balances. */
+            userBalances: v.pipe(v.array(v.tuple([_base_js_1.Address, v.string()])), v.description("User balances.")),
+            /** Existing token balances. */
+            existingTokenBalances: v.pipe(v.array(v.tuple([_base_js_1.UnsignedInteger, v.string()])), v.description("Existing token balances.")),
+            /** Blacklisted users. */
+            blacklistUsers: v.pipe(v.array(_base_js_1.Address), v.description("Blacklisted users.")),
+        })), v.description("Genesis data for the token.")),
+        /** Deployer address. */
+        deployer: v.pipe(v.nullable(_base_js_1.Address), v.description("Deployer address.")),
+        /** Gas used during token deployment. */
+        deployGas: v.pipe(v.nullable(_base_js_1.UnsignedDecimal), v.description("Gas used during token deployment.")),
+        /** Deployment time. */
+        deployTime: v.pipe(v.nullable(v.string()), v.description("Deployment time.")),
+        /** Seeded USDC amount for the token. */
+        seededUsdc: v.pipe(_base_js_1.UnsignedDecimal, v.description("Seeded USDC amount for the token.")),
+        /** Non-circulating user balances of the token. */
+        nonCirculatingUserBalances: v.pipe(v.array(v.tuple([_base_js_1.Address, v.string()])), v.description("Non-circulating user balances of the token.")),
+        /** Future emissions amount. */
+        futureEmissions: v.pipe(_base_js_1.UnsignedDecimal, v.description("Future emissions amount.")),
+    }), v.description("Details of a token."));
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+const _base_js_2 = require("../_base.js");
+/**
+ * Request token details.
+ * @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 Details of a token.
+ *
+ * @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-a-token
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { tokenDetails } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await tokenDetails(
+ *   { transport },
+ *   { tokenId: "0x..." },
+ * );
+ * ```
+ */
+function tokenDetails(config, params, signal) {
+    const request = (0, _base_js_2.parser)(exports.TokenDetailsRequest)({
+        type: "tokenDetails",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=tokenDetails.js.map

package/script/src/api/info/tokenDetails.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenDetails.js","sourceRoot":"","sources":["../../../../src/src/api/info/tokenDetails.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8KA,oCAUC;AAxLD,2CAA6B;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,0CAA6E;AAE7E;;;GAGG;AACU,QAAA,mBAAmB,GAAmB,CAAC,GAAG,EAAE;IACvD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,gBAAgB;QAChB,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,CAAC,CAAC,IAAI,CAAC,cAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAC3B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,wBAAwB,CAAC,CACxC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACU,QAAA,oBAAoB,GAAmB,CAAC,GAAG,EAAE;IACxD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,yBAAyB;QACzB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;QACD,mCAAmC;QACnC,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAC9C;QACD,iCAAiC;QACjC,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAC5C;QACD,uCAAuC;QACvC,iBAAiB,EAAE,CAAC,CAAC,IAAI,CACvB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;QACD,oDAAoD;QACpD,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,+CAA+C,CAAC,CAC/D;QACD,oDAAoD;QACpD,WAAW,EAAE,CAAC,CAAC,IAAI,CACjB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,+CAA+C,CAAC,CAC/D;QACD,8BAA8B;QAC9B,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC;QACD,+BAA+B;QAC/B,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;QACD,yCAAyC;QACzC,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,oCAAoC,CAAC,CACpD;QACD,kCAAkC;QAClC,OAAO,EAAE,CAAC,CAAC,IAAI,CACb,CAAC,CAAC,QAAQ,CACR,CAAC,CAAC,MAAM,CAAC;YACP,qBAAqB;YACrB,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,kBAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EACvC,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAChC;YACD,+BAA+B;YAC/B,qBAAqB,EAAE,CAAC,CAAC,IAAI,CAC3B,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,0BAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAC/C,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;YACD,yBAAyB;YACzB,cAAc,EAAE,CAAC,CAAC,IAAI,CACpB,CAAC,CAAC,KAAK,CAAC,kBAAO,CAAC,EAChB,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;SACF,CAAC,CACH,EACD,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C;QACD,wBAAwB;QACxB,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,QAAQ,CAAC,kBAAO,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;QACD,wCAAwC;QACxC,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,QAAQ,CAAC,0BAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,mCAAmC,CAAC,CACnD;QACD,uBAAuB;QACvB,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,wCAAwC;QACxC,UAAU,EAAE,CAAC,CAAC,IAAI,CAChB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,mCAAmC,CAAC,CACnD;QACD,kDAAkD;QAClD,0BAA0B,EAAE,CAAC,CAAC,IAAI,CAChC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,kBAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EACvC,CAAC,CAAC,WAAW,CAAC,6CAA6C,CAAC,CAC7D;QACD,+BAA+B;QAC/B,eAAe,EAAE,CAAC,CAAC,IAAI,CACrB,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAC1C;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,qBAAqB,CAAC,CACrC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,0CAAyD;AAMzD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,YAAY,CAC1B,MAAyB,EACzB,MAA6C,EAC7C,MAAoB;IAEpB,MAAM,OAAO,GAAG,IAAA,iBAAM,EAAC,2BAAmB,CAAC,CAAC;QAC1C,IAAI,EAAE,cAAc;QACpB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

package/script/src/api/info/twapHistory.d.ts

@@ -0,0 +1,132 @@
+import * as v from "valibot";
+/**
+ * Request twap history of a user.
+ * @see null
+ */
+export declare const TwapHistoryRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"twapHistory", undefined>, v.DescriptionAction<"twapHistory", "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: "twapHistory";
+    user: `0x${string}`;
+}, "Request twap history of a user.">]>;
+export type TwapHistoryRequest = v.InferOutput<typeof TwapHistoryRequest>;
+/**
+ * Array of user's TWAP history.
+ * @see null
+ */
+export declare const TwapHistoryResponse: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Creation time of the history record (in seconds since epoch). */
+    readonly time: 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, "Creation time of the history record (in seconds since epoch).">]>;
+    /** State of the TWAP order. */
+    readonly state: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
+        readonly executedNtl: 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, "Executed notional value.">]>;
+        readonly executedSz: 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, "Executed size.">]>;
+        readonly minutes: 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, "Duration in minutes.">]>;
+        readonly randomize: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates if the TWAP randomizes execution.">]>;
+        readonly reduceOnly: v.SchemaWithPipe<readonly [v.BooleanSchema<undefined>, v.DescriptionAction<boolean, "Indicates if the order is reduce-only.">]>;
+        readonly side: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"B", undefined>, v.LiteralSchema<"A", undefined>], undefined>, v.DescriptionAction<"B" | "A", "Order side (\"B\" = Bid/Buy, \"A\" = Ask/Sell).">]>;
+        readonly sz: 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, "Order size.">]>;
+        readonly timestamp: 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, "Start time of the TWAP order (in ms since epoch).">]>;
+        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<{
+        coin: string;
+        executedNtl: string;
+        executedSz: string;
+        minutes: number;
+        randomize: boolean;
+        reduceOnly: boolean;
+        side: "B" | "A";
+        sz: string;
+        timestamp: number;
+        user: `0x${string}`;
+    }, "State of the TWAP order.">]>;
+    /** Current status of the TWAP order. */
+    readonly status: v.SchemaWithPipe<readonly [v.VariantSchema<"status", [v.ObjectSchema<{
+        readonly status: v.SchemaWithPipe<readonly [v.UnionSchema<[v.LiteralSchema<"finished", undefined>, v.LiteralSchema<"activated", undefined>, v.LiteralSchema<"terminated", undefined>], undefined>, v.DescriptionAction<"finished" | "activated" | "terminated", "Status of the TWAP order.">]>;
+    }, undefined>, v.ObjectSchema<{
+        readonly status: v.SchemaWithPipe<readonly [v.LiteralSchema<"error", undefined>, v.DescriptionAction<"error", "Status of the TWAP order.">]>;
+        readonly description: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Error message.">]>;
+    }, undefined>], undefined>, v.DescriptionAction<{
+        status: "finished" | "activated" | "terminated";
+    } | {
+        status: "error";
+        description: string;
+    }, string>]>;
+    /** ID of the TWAP. */
+    readonly twapId: 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, "ID of the TWAP.">]>;
+}, undefined>, v.DescriptionAction<{
+    time: number;
+    state: {
+        coin: string;
+        executedNtl: string;
+        executedSz: string;
+        minutes: number;
+        randomize: boolean;
+        reduceOnly: boolean;
+        side: "B" | "A";
+        sz: string;
+        timestamp: number;
+        user: `0x${string}`;
+    };
+    status: {
+        status: "finished" | "activated" | "terminated";
+    } | {
+        status: "error";
+        description: string;
+    };
+    twapId?: number | undefined;
+}, "TWAP history record.">]>, undefined>, v.DescriptionAction<{
+    time: number;
+    state: {
+        coin: string;
+        executedNtl: string;
+        executedSz: string;
+        minutes: number;
+        randomize: boolean;
+        reduceOnly: boolean;
+        side: "B" | "A";
+        sz: string;
+        timestamp: number;
+        user: `0x${string}`;
+    };
+    status: {
+        status: "finished" | "activated" | "terminated";
+    } | {
+        status: "error";
+        description: string;
+    };
+    twapId?: number | undefined;
+}[], "Array of user's TWAP history.">]>;
+export type TwapHistoryResponse = v.InferOutput<typeof TwapHistoryResponse>;
+import { type DeepImmutable } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+/** Request parameters for the {@linkcode twapHistory} function. */
+export type TwapHistoryParameters = Omit<v.InferInput<typeof TwapHistoryRequest>, "type">;
+/**
+ * Request twap history of a user.
+ * @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 Array of user's TWAP history.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { twapHistory } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await twapHistory(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export declare function twapHistory(config: InfoRequestConfig, params: DeepImmutable<TwapHistoryParameters>, signal?: AbortSignal): Promise<TwapHistoryResponse>;
+//# sourceMappingURL=twapHistory.d.ts.map

package/script/src/api/info/twapHistory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"twapHistory.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/twapHistory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAS7B;;;GAGG;AACH,eAAO,MAAM,kBAAkB;IAGzB,uBAAuB;;IAKvB,oBAAoB;;;;;uCAQtB,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1E;;;GAGG;AACH,eAAO,MAAM,mBAAmB;IAMtB,oEAAoE;;IAKpE,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;IAE/B,wCAAwC;;;;;;;;;;;;IAExC,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uCAW5B,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,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAErD,mEAAmE;AACnE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE1F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,aAAa,CAAC,qBAAqB,CAAC,EAC5C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,mBAAmB,CAAC,CAM9B"}

package/script/src/api/info/twapHistory.js

@@ -0,0 +1,107 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TwapHistoryResponse = exports.TwapHistoryRequest = void 0;
+exports.twapHistory = twapHistory;
+const v = __importStar(require("valibot"));
+// ============================================================
+// API Schemas
+// ============================================================
+const _base_js_1 = require("../_base.js");
+const _common_schemas_js_1 = require("../_common_schemas.js");
+/**
+ * Request twap history of a user.
+ * @see null
+ */
+exports.TwapHistoryRequest = (() => {
+    return v.pipe(v.object({
+        /** Type of request. */
+        type: v.pipe(v.literal("twapHistory"), v.description("Type of request.")),
+        /** User address. */
+        user: v.pipe(_base_js_1.Address, v.description("User address.")),
+    }), v.description("Request twap history of a user."));
+})();
+/**
+ * Array of user's TWAP history.
+ * @see null
+ */
+exports.TwapHistoryResponse = (() => {
+    return v.pipe(v.array(
+    /** TWAP history record. */
+    v.pipe(v.object({
+        /** Creation time of the history record (in seconds since epoch). */
+        time: v.pipe(_base_js_1.UnsignedInteger, v.description("Creation time of the history record (in seconds since epoch).")),
+        /** State of the TWAP order. */
+        state: _common_schemas_js_1.TwapStateSchema,
+        /** Current status of the TWAP order. */
+        status: _common_schemas_js_1.TwapStatusSchema,
+        /** ID of the TWAP. */
+        twapId: v.pipe(v.optional(_base_js_1.UnsignedInteger), v.description("ID of the TWAP.")),
+    }), v.description("TWAP history record."))), v.description("Array of user's TWAP history."));
+})();
+// ============================================================
+// Execution Logic
+// ============================================================
+const _base_js_2 = require("../_base.js");
+/**
+ * Request twap history of a user.
+ * @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 Array of user's TWAP history.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { twapHistory } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await twapHistory(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+function twapHistory(config, params, signal) {
+    const request = (0, _base_js_2.parser)(exports.TwapHistoryRequest)({
+        type: "twapHistory",
+        ...params,
+    });
+    return config.transport.request("info", request, signal);
+}
+//# sourceMappingURL=twapHistory.js.map

package/script/src/api/info/twapHistory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"twapHistory.js","sourceRoot":"","sources":["../../../../src/src/api/info/twapHistory.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiGA,kCAUC;AA3GD,2CAA6B;AAE7B,+DAA+D;AAC/D,cAAc;AACd,+DAA+D;AAE/D,0CAAuD;AACvD,8DAA0E;AAE1E;;;GAGG;AACU,QAAA,kBAAkB,GAAmB,CAAC,GAAG,EAAE;IACtD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,uBAAuB;QACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EACxB,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAClC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,kBAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,iCAAiC,CAAC,CACjD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL;;;GAGG;AACU,QAAA,mBAAmB,GAAmB,CAAC,GAAG,EAAE;IACvD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK;IACL,2BAA2B;IAC3B,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,oEAAoE;QACpE,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,+DAA+D,CAAC,CAC/E;QACD,+BAA+B;QAC/B,KAAK,EAAE,oCAAe;QACtB,wCAAwC;QACxC,MAAM,EAAE,qCAAgB;QACxB,sBAAsB;QACtB,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,QAAQ,CAAC,0BAAe,CAAC,EAC3B,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,CACjC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC,CACF,EACD,CAAC,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAC/C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,+DAA+D;AAC/D,kBAAkB;AAClB,+DAA+D;AAE/D,0CAAyD;AAMzD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,WAAW,CACzB,MAAyB,EACzB,MAA4C,EAC5C,MAAoB;IAEpB,MAAM,OAAO,GAAG,IAAA,iBAAM,EAAC,0BAAkB,CAAC,CAAC;QACzC,IAAI,EAAE,aAAa;QACnB,GAAG,MAAM;KACV,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC"}

package/script/src/api/info/txDetails.d.ts

@@ -0,0 +1,102 @@
+import * as v from "valibot";
+/**
+ * Request transaction details by transaction hash.
+ * @see null
+ */
+export declare const TxDetailsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Type of request. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"txDetails", undefined>, v.DescriptionAction<"txDetails", "Type of request.">]>;
+    /** Transaction hash. */
+    readonly hash: 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}`, "Transaction hash.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "txDetails";
+    hash: `0x${string}`;
+}, "Request transaction details by transaction hash.">]>;
+export type TxDetailsRequest = v.InferOutput<typeof TxDetailsRequest>;
+/**
+ * Response with transaction details.
+ * @see null
+ */
+export declare const TxDetailsResponse: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+    /** Response type. */
+    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"txDetails", undefined>, v.DescriptionAction<"txDetails", "Response type.">]>;
+    /** Transaction details. */
+    readonly tx: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+        /** Action performed in transaction. */
+        readonly action: v.SchemaWithPipe<readonly [v.LooseObjectSchema<{
+            /** Action type. */
+            readonly type: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Action type.">]>;
+        }, undefined>, v.DescriptionAction<{
+            type: string;
+        } & {
+            [key: string]: unknown;
+        }, "Action performed in transaction.">]>;
+        /** Block number where transaction was included. */
+        readonly block: 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, "Block number where transaction was included.">]>;
+        /** Error message if transaction failed. */
+        readonly error: v.SchemaWithPipe<readonly [v.NullableSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | null, "Error message if transaction failed.">]>;
+        /** Transaction hash. */
+        readonly hash: 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}`, "Transaction hash.">]>;
+        /** Transaction creation timestamp. */
+        readonly time: 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, "Transaction creation timestamp.">]>;
+        /** Creator's 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}`, "Creator's address.">]>;
+    }, undefined>, v.DescriptionAction<{
+        action: {
+            type: string;
+        } & {
+            [key: string]: unknown;
+        };
+        block: number;
+        error: string | null;
+        hash: `0x${string}`;
+        time: number;
+        user: `0x${string}`;
+    }, "Transaction details.">]>;
+}, undefined>, v.DescriptionAction<{
+    type: "txDetails";
+    tx: {
+        action: {
+            type: string;
+        } & {
+            [key: string]: unknown;
+        };
+        block: number;
+        error: string | null;
+        hash: `0x${string}`;
+        time: number;
+        user: `0x${string}`;
+    };
+}, "Response with transaction details.">]>;
+export type TxDetailsResponse = v.InferOutput<typeof TxDetailsResponse>;
+import { type DeepImmutable } from "../_base.js";
+import type { InfoRequestConfig } from "./_types.js";
+import type { IRequestTransport } from "../../transport/base.js";
+/** Request parameters for the {@linkcode txDetails} function. */
+export type TxDetailsParameters = Omit<v.InferInput<typeof TxDetailsRequest>, "type">;
+/**
+ * Request transaction details by transaction hash.
+ * @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 Transaction details.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { txDetails } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // only `HttpTransport` supports this API
+ * const data = await txDetails(
+ *   { transport },
+ *   { hash: "0x..." },
+ * );
+ * ```
+ */
+export declare function txDetails<T extends IRequestTransport>(config: T extends {
+    request(endpoint: "explorer", ...args: unknown[]): unknown;
+} ? InfoRequestConfig<T> : never, params: DeepImmutable<TxDetailsParameters>, signal?: AbortSignal): Promise<TxDetailsResponse>;
+//# sourceMappingURL=txDetails.d.ts.map

package/script/src/api/info/txDetails.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"txDetails.d.ts","sourceRoot":"","sources":["../../../../src/src/api/info/txDetails.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAQ7B;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAGvB,uBAAuB;;IAKvB,wBAAwB;;;;;wDAQ1B,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEtE;;;GAGG;AACH,eAAO,MAAM,iBAAiB;IAGxB,qBAAqB;;IAKrB,2BAA2B;;QAGvB,uCAAuC;;YAGnC,mBAAmB;;;;;;;QAQvB,mDAAmD;;QAKnD,2CAA2C;;QAK3C,wBAAwB;;QAKxB,sCAAsC;;QAKtC,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;0CAW/B,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,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAEjE,iEAAiE;AACjE,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,EAAE,MAAM,CAAC,CAAC;AAEtF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,iBAAiB,EACnD,MAAM,EAAE,CAAC,SAAS;IAAE,OAAO,CAAC,QAAQ,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;CAAE,GAAG,iBAAiB,CAAC,CAAC,CAAC,GAAG,KAAK,EAC/G,MAAM,EAAE,aAAa,CAAC,mBAAmB,CAAC,EAC1C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,iBAAiB,CAAC,CAM5B"}