@nktkas/hyperliquid 0.25.3 → 0.25.5

package/script/src/utils/_symbolConverter.d.ts

@@ -0,0 +1,77 @@
+import type { IRequestTransport } from "../transport/base.js";
+export type DexOption = string[] | boolean;
+/** Options for creating a SymbolConverter instance. */
+export interface SymbolConverterOptions {
+    /** Transport instance to use for API requests. */
+    transport: IRequestTransport;
+    /** Optional dex support: array of dex names, true for all dexs, or false/undefined to skip. */
+    dexs?: DexOption;
+}
+/**
+ * Utility class for converting asset symbols to their corresponding IDs and size decimals.
+ * Supports perpetuals, spot markets, and optional builder dexs.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/asset-ids
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { SymbolConverter } from "@nktkas/hyperliquid/utils";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const converter = await SymbolConverter.create({ transport });
+ *
+ * const btcId = converter.getAssetId("BTC"); // perpetual → 0
+ * const hypeUsdcId = converter.getAssetId("HYPE/USDC"); // spot market → 10107
+ * const dexAbcId = converter.getAssetId("test:ABC"); // builder dex (if enabled) → 110000
+ *
+ * const btcSzDecimals = converter.getSzDecimals("BTC"); // perpetual → 5
+ * const hypeUsdcSzDecimals = converter.getSzDecimals("HYPE/USDC"); // spot market → 2
+ * const dexAbcSzDecimals = converter.getSzDecimals("test:ABC"); // builder dex (if enabled) → 0
+ * ```
+ */
+export declare class SymbolConverter {
+    private readonly transport;
+    private readonly dexOption;
+    private readonly nameToAssetId;
+    private readonly nameToSzDecimals;
+    private constructor();
+    /**
+     * Create and initialize a SymbolConverter instance.
+     * @param options - Configuration options including transport and optional dex support.
+     * @returns Initialized SymbolConverter instance.
+     * @example
+     * ```ts
+     * import { HttpTransport } from "@nktkas/hyperliquid";
+     * import { SymbolConverter } from "@nktkas/hyperliquid/utils";
+     *
+     * const transport = new HttpTransport(); // or `WebSocketTransport`
+     * const converter = await SymbolConverter.create({ transport });
+     * ```
+     */
+    static create(options: SymbolConverterOptions): Promise<SymbolConverter>;
+    /**
+     * Reload asset mappings from the API.
+     * Useful for refreshing data when new assets are added.
+     */
+    reload(): Promise<void>;
+    private processDefaultPerps;
+    private processBuilderDexs;
+    private processBuilderDexResult;
+    private processSpotAssets;
+    /**
+     * Get asset ID for a coin.
+     * - For Perpetuals, use the coin name (e.g., "BTC").
+     * - For Spot markets, use the "BASE/QUOTE" format (e.g., "HYPE/USDC").
+     * - For Builder Dex assets, use the "DEX_NAME:ASSET_NAME" format (e.g., "test:ABC").
+     * @example "BTC" → 0, "HYPE/USDC" → 10107, "test:ABC" → 110000
+     */
+    getAssetId(name: string): number | undefined;
+    /**
+     * Get size decimals for a coin.
+     * - For Perpetuals, use the coin name (e.g., "BTC").
+     * - For Spot markets, use the "BASE/QUOTE" format (e.g., "HYPE/USDC").
+     * - For Builder Dex assets, use the "DEX_NAME:ASSET_NAME" format (e.g., "test:ABC").
+     * @example "BTC" → 5, "HYPE/USDC" → 2, "test:ABC" → 0
+     */
+    getSzDecimals(name: string): number | undefined;
+}
+//# sourceMappingURL=_symbolConverter.d.ts.map

package/script/src/utils/_symbolConverter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_symbolConverter.d.ts","sourceRoot":"","sources":["../../../src/src/utils/_symbolConverter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAK9D,MAAM,MAAM,SAAS,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC;AAE3C,uDAAuD;AACvD,MAAM,WAAW,sBAAsB;IACrC,kDAAkD;IAClD,SAAS,EAAE,iBAAiB,CAAC;IAC7B,+FAA+F;IAC/F,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA6B;IAC3D,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA6B;IAE9D,OAAO;IAKP;;;;;;;;;;;;OAYG;WACU,MAAM,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,eAAe,CAAC;IAM9E;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IA4B7B,OAAO,CAAC,mBAAmB;YAOb,kBAAkB;IA6BhC,OAAO,CAAC,uBAAuB;IAU/B,OAAO,CAAC,iBAAiB;IAmBzB;;;;;;OAMG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI5C;;;;;;OAMG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;CAGhD"}

package/script/src/utils/_symbolConverter.js

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SymbolConverter = void 0;
+const meta_js_1 = require("../api/info/meta.js");
+const spotMeta_js_1 = require("../api/info/spotMeta.js");
+const perpDexs_js_1 = require("../api/info/perpDexs.js");
+/**
+ * Utility class for converting asset symbols to their corresponding IDs and size decimals.
+ * Supports perpetuals, spot markets, and optional builder dexs.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/asset-ids
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { SymbolConverter } from "@nktkas/hyperliquid/utils";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const converter = await SymbolConverter.create({ transport });
+ *
+ * const btcId = converter.getAssetId("BTC"); // perpetual → 0
+ * const hypeUsdcId = converter.getAssetId("HYPE/USDC"); // spot market → 10107
+ * const dexAbcId = converter.getAssetId("test:ABC"); // builder dex (if enabled) → 110000
+ *
+ * const btcSzDecimals = converter.getSzDecimals("BTC"); // perpetual → 5
+ * const hypeUsdcSzDecimals = converter.getSzDecimals("HYPE/USDC"); // spot market → 2
+ * const dexAbcSzDecimals = converter.getSzDecimals("test:ABC"); // builder dex (if enabled) → 0
+ * ```
+ */
+class SymbolConverter {
+    transport;
+    dexOption;
+    nameToAssetId = new Map();
+    nameToSzDecimals = new Map();
+    constructor(options) {
+        this.transport = options.transport;
+        this.dexOption = options.dexs ?? false;
+    }
+    /**
+     * Create and initialize a SymbolConverter instance.
+     * @param options - Configuration options including transport and optional dex support.
+     * @returns Initialized SymbolConverter instance.
+     * @example
+     * ```ts
+     * import { HttpTransport } from "@nktkas/hyperliquid";
+     * import { SymbolConverter } from "@nktkas/hyperliquid/utils";
+     *
+     * const transport = new HttpTransport(); // or `WebSocketTransport`
+     * const converter = await SymbolConverter.create({ transport });
+     * ```
+     */
+    static async create(options) {
+        const instance = new SymbolConverter(options);
+        await instance.reload();
+        return instance;
+    }
+    /**
+     * Reload asset mappings from the API.
+     * Useful for refreshing data when new assets are added.
+     */
+    async reload() {
+        const config = { transport: this.transport };
+        const [perpMetaData, spotMetaData, perpDexsData] = await Promise.all([
+            (0, meta_js_1.meta)(config),
+            (0, spotMeta_js_1.spotMeta)(config),
+            (0, perpDexs_js_1.perpDexs)(config),
+        ]);
+        if (!perpMetaData?.universe?.length) {
+            throw new Error("Invalid perpetual metadata response");
+        }
+        if (!spotMetaData?.universe?.length || !spotMetaData?.tokens?.length) {
+            throw new Error("Invalid spot metadata response");
+        }
+        this.nameToAssetId.clear();
+        this.nameToSzDecimals.clear();
+        this.processDefaultPerps(perpMetaData);
+        this.processSpotAssets(spotMetaData);
+        // Only process builder dexs if dex support is enabled
+        if (this.dexOption !== false) {
+            await this.processBuilderDexs(perpDexsData);
+        }
+    }
+    processDefaultPerps(perpMeta) {
+        perpMeta.universe.forEach((asset, index) => {
+            this.nameToAssetId.set(asset.name, index);
+            this.nameToSzDecimals.set(asset.name, asset.szDecimals);
+        });
+    }
+    async processBuilderDexs(perpDexs) {
+        if (!perpDexs || perpDexs.length <= 1)
+            return;
+        const builderDexs = perpDexs
+            .map((dex, index) => ({ dex, index }))
+            .filter((item) => {
+            return item.index > 0 && item.dex !== null && item.dex.name.length > 0;
+        });
+        if (builderDexs.length === 0)
+            return;
+        // Filter dexs based on the dexOption
+        const dexsToProcess = Array.isArray(this.dexOption)
+            ? builderDexs.filter((item) => this.dexOption.includes(item.dex.name))
+            : builderDexs; // true means process all
+        if (dexsToProcess.length === 0)
+            return;
+        const config = { transport: this.transport };
+        const results = await Promise.allSettled(dexsToProcess.map((item) => (0, meta_js_1.meta)(config, { dex: item.dex.name })));
+        results.forEach((result, idx) => {
+            if (result.status !== "fulfilled")
+                return;
+            this.processBuilderDexResult(result.value, dexsToProcess[idx].index);
+        });
+    }
+    processBuilderDexResult(meta, perpDexIndex) {
+        const offset = 100000 + perpDexIndex * 10000;
+        meta.universe.forEach((asset, index) => {
+            const assetId = offset + index;
+            this.nameToAssetId.set(asset.name, assetId);
+            this.nameToSzDecimals.set(asset.name, asset.szDecimals);
+        });
+    }
+    processSpotAssets(spotMeta) {
+        const tokenMap = new Map();
+        spotMeta.tokens.forEach((token) => {
+            tokenMap.set(token.index, { name: token.name, szDecimals: token.szDecimals });
+        });
+        spotMeta.universe.forEach((market) => {
+            if (market.tokens.length < 2)
+                return;
+            const baseToken = tokenMap.get(market.tokens[0]);
+            const quoteToken = tokenMap.get(market.tokens[1]);
+            if (!baseToken || !quoteToken)
+                return;
+            const assetId = 10000 + market.index;
+            const baseQuoteKey = `${baseToken.name}/${quoteToken.name}`;
+            this.nameToAssetId.set(baseQuoteKey, assetId);
+            this.nameToSzDecimals.set(baseQuoteKey, baseToken.szDecimals);
+        });
+    }
+    /**
+     * Get asset ID for a coin.
+     * - For Perpetuals, use the coin name (e.g., "BTC").
+     * - For Spot markets, use the "BASE/QUOTE" format (e.g., "HYPE/USDC").
+     * - For Builder Dex assets, use the "DEX_NAME:ASSET_NAME" format (e.g., "test:ABC").
+     * @example "BTC" → 0, "HYPE/USDC" → 10107, "test:ABC" → 110000
+     */
+    getAssetId(name) {
+        return this.nameToAssetId.get(name);
+    }
+    /**
+     * Get size decimals for a coin.
+     * - For Perpetuals, use the coin name (e.g., "BTC").
+     * - For Spot markets, use the "BASE/QUOTE" format (e.g., "HYPE/USDC").
+     * - For Builder Dex assets, use the "DEX_NAME:ASSET_NAME" format (e.g., "test:ABC").
+     * @example "BTC" → 5, "HYPE/USDC" → 2, "test:ABC" → 0
+     */
+    getSzDecimals(name) {
+        return this.nameToSzDecimals.get(name);
+    }
+}
+exports.SymbolConverter = SymbolConverter;
+//# sourceMappingURL=_symbolConverter.js.map

package/script/src/utils/_symbolConverter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_symbolConverter.js","sourceRoot":"","sources":["../../../src/src/utils/_symbolConverter.ts"],"names":[],"mappings":";;;AACA,iDAA8D;AAC9D,yDAA0E;AAC1E,yDAA0E;AAY1E;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,eAAe;IACT,SAAS,CAAoB;IAC7B,SAAS,CAAY;IACrB,aAAa,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,gBAAgB,GAAG,IAAI,GAAG,EAAkB,CAAC;IAE9D,YAAoB,OAA+B;QACjD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAA+B;QACjD,MAAM,QAAQ,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC;QAC9C,MAAM,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,MAAM,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;QAC7C,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,YAAY,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACnE,IAAA,cAAI,EAAC,MAAM,CAAC;YACZ,IAAA,sBAAQ,EAAC,MAAM,CAAC;YAChB,IAAA,sBAAQ,EAAC,MAAM,CAAC;SACjB,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;YACrE,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QAC3B,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAE9B,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACvC,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;QAErC,sDAAsD;QACtD,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,EAAE,CAAC;YAC7B,MAAM,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAEO,mBAAmB,CAAC,QAAsB;QAChD,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACzC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC1C,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,QAA0B;QACzD,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC;YAAE,OAAO;QAE9C,MAAM,WAAW,GAAG,QAAQ;aACzB,GAAG,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;aACrC,MAAM,CAAC,CAAC,IAAI,EAAyE,EAAE;YACtF,OAAO,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,KAAK,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;QAEL,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAErC,qCAAqC;QACrC,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC;YACjD,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAE,IAAI,CAAC,SAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACpF,CAAC,CAAC,WAAW,CAAC,CAAC,yBAAyB;QAE1C,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAEvC,MAAM,MAAM,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;QAC7C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CACtC,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,cAAI,EAAC,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAClE,CAAC;QAEF,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;YAC9B,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW;gBAAE,OAAO;YAC1C,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,uBAAuB,CAAC,IAAkB,EAAE,YAAoB;QACtE,MAAM,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,KAAK,CAAC;QAE7C,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACrC,MAAM,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC;YAC/B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAC5C,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,iBAAiB,CAAC,QAA0B;QAClD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAgD,CAAC;QACzE,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAChC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC;QAChF,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACnC,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;gBAAE,OAAO;YACrC,MAAM,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YACjD,MAAM,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YAClD,IAAI,CAAC,SAAS,IAAI,CAAC,UAAU;gBAAE,OAAO;YAEtC,MAAM,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;YACrC,MAAM,YAAY,GAAG,GAAG,SAAS,CAAC,IAAI,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC;YAC5D,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YAC9C,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,IAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,IAAY;QACxB,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;CACF;AApJD,0CAoJC"}

package/script/src/utils/mod.d.ts

@@ -0,0 +1,2 @@
+export * from "./_symbolConverter.js";
+//# sourceMappingURL=mod.d.ts.map

package/script/src/utils/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../src/src/utils/mod.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC"}

package/script/src/utils/mod.js

@@ -0,0 +1,18 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./_symbolConverter.js"), exports);
+//# sourceMappingURL=mod.js.map

package/script/src/utils/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../../src/src/utils/mod.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC"}

package/src/bin/cli.ts

@@ -108,156 +108,156 @@ INFO ENDPOINT METHODS
 Market Data:
   alignedQuoteTokenInfo   --token <number>
   allMids                 [--dex <string>]
-  l2Book                  --coin <string> [--nSigFigs <2|3|4|5>] [--mantissa <2|5>]
-  candleSnapshot          --coin <string> --interval <1m|3m|5m|15m|30m|1h|2h|4h|8h|12h|1d|3d|1w|1M> 
+  candleSnapshot          --coin <string> --interval <1m|3m|5m|15m|30m|1h|2h|4h|8h|12h|1d|3d|1w|1M>
                           --startTime <number> [--endTime <number>]
   fundingHistory          --coin <string> --startTime <number> [--endTime <number>]
-  predictedFundings       (no params)
-  recentTrades            --coin <string>
-
-Exchange Information:
+  l2Book                  --coin <string> [--nSigFigs <2|3|4|5>] [--mantissa <2|5>]
+  liquidatable            (no params)
+  marginTable             --id <number>
+  maxMarketOrderNtls      (no params)
   meta                    [--dex <string>]
   metaAndAssetCtxs        [--dex <string>]
+  perpDexLimits           --dex <string>
+  perpDexs                (no params)
+  perpsAtOpenInterestCap  [--dex <string>]
+  predictedFundings       (no params)
+  recentTrades            --coin <string>
   spotMeta                (no params)
   spotMetaAndAssetCtxs    (no params)
-  exchangeStatus          (no params)
-  perpDexs                (no params)
-  perpDexLimits           --dex <string>
-  spotPairDeployAuctionStatus  (no params)
-  perpDeployAuctionStatus      (no params)
-  perpsAtOpenInterestCap       [--dex <string>]
-  maxMarketOrderNtls           (no params)
-  liquidatable                 (no params)
-  marginTable                  --id <number>
 
-User Account Data:
-  clearinghouseState      --user <address> [--dex <string>]
-  spotClearinghouseState  --user <address> [--dex <string>]
-  portfolio               --user <address>
-  openOrders              --user <address> [--dex <string>]
-  frontendOpenOrders      --user <address> [--dex <string>]
-  historicalOrders        --user <address>
-  orderStatus             --user <address> --oid <number|hex>
-  userDetails             --user <address>
-  userFees                --user <address>
-  userRateLimit           --user <address>
-  userRole                --user <address>
+User Account:
   activeAssetData         --user <address> --coin <string>
+  clearinghouseState      --user <address> [--dex <string>]
+  extraAgents             --user <address>
   isVip                   --user <address>
   legalCheck              --user <address>
-  referral                --user <address>
-  spotDeployState         --user <address>
-  preTransferCheck        --user <address> --source <address>
   maxBuilderFee           --user <address> --builder <address>
-  webData2                --user <address>
-
-User Trading History:
-  userFills               --user <address> [--aggregateByTime <bool>]
-  userFillsByTime         --user <address> --startTime <number> [--endTime <number>] 
-                          [--aggregateByTime <bool>]
+  portfolio               --user <address>
+  preTransferCheck        --user <address> --source <address>
+  referral                --user <address>
+  spotClearinghouseState  --user <address> [--dex <string>]
+  subAccounts             --user <address>
+  userDexAbstraction      --user <address>
+  userFees                --user <address>
   userFunding             --user <address> --startTime <number> [--endTime <number>]
   userNonFundingLedgerUpdates  --user <address> --startTime <number> [--endTime <number>]
-  twapHistory             --user <address>
-  userTwapSliceFills      --user <address>
-  userTwapSliceFillsByTime     --user <address> --startTime <number> [--endTime <number>] 
-                               [--aggregateByTime <bool>]
-
-Sub-Account & Multi-Sig:
-  subAccounts             --user <address>
-  extraAgents             --user <address>
+  userRateLimit           --user <address>
+  userRole                --user <address>
   userToMultiSigSigners   --user <address>
+  webData2                --user <address>
 
-Vault Information:
-  vaultSummaries          (no params)
-  vaultDetails            --vaultAddress <address> [--user <address>]
-  leadingVaults           --user <address>
-  userVaultEquities       --user <address>
+Orders & TWAP & Position:
+  frontendOpenOrders      --user <address> [--dex <string>]
+  historicalOrders        --user <address>
+  openOrders              --user <address> [--dex <string>]
+  orderStatus             --user <address> --oid <number|hex>
+  twapHistory             --user <address>
+  userFills               --user <address> [--aggregateByTime <bool>]
+  userFillsByTime         --user <address> --startTime <number>
+                          [--endTime <number>] [--aggregateByTime <bool>]
+  userTwapSliceFills           --user <address>
+  userTwapSliceFillsByTime     --user <address> --startTime <number>
+                               [--endTime <number>] [--aggregateByTime <bool>]
 
 Delegation & Validators:
   delegations             --user <address>
   delegatorHistory        --user <address>
   delegatorRewards        --user <address>
   delegatorSummary        --user <address>
+  gossipRootIps           (no params)
   validatorL1Votes        (no params)
   validatorSummaries      (no params)
-  gossipRootIps           (no params)
+
+Vault:
+  leadingVaults           --user <address>
+  userVaultEquities       --user <address>
+  vaultDetails            --vaultAddress <address> [--user <address>]
+  vaultSummaries          (no params)
+
+Deploy Market:
+  perpDeployAuctionStatus      (no params)
+  spotDeployState              --user <address>
+  spotPairDeployAuctionStatus  (no params)
+
+Other:
+  exchangeStatus          (no params)
 
 Transaction & Block Details:
-  txDetails               --hash <hex>
   blockDetails            --height <number>
   tokenDetails            --tokenId <hex>
+  txDetails               --hash <hex>
+  userDetails             --user <address>
 
 =============================================================================
 EXCHANGE ENDPOINT METHODS
 =============================================================================
 
-Trading Operations:
-  order                   --orders <json> [--grouping <na|normalTpsl|positionTpsl>] 
-                          [--builder <json>]
-  modify                  --oid <number|hex> --order <json>
+Order & TWAP & Position:
   batchModify             --modifies <json>
   cancel                  --cancels <json>
   cancelByCloid           --cancels <json>
+  modify                  --oid <number|hex> --order <json>
+  order                   --orders <json> [--grouping <na|normalTpsl|positionTpsl>] [--builder <json>]
   scheduleCancel          [--time <number>]
-
-TWAP Operations:
-  twapOrder               --a <number> --b <bool> --s <number> --r <bool> --m <number> --t <bool>
   twapCancel              --a <number> --t <number>
-
-Position Management:
-  updateLeverage          --asset <number> --isCross <bool> --leverage <number>
+  twapOrder               --a <number> --b <bool> --s <number> --r <bool> --m <number> --t <bool>
   updateIsolatedMargin    --asset <number> --isBuy <bool> --ntli <number>
+  updateLeverage          --asset <number> --isCross <bool> --leverage <number>
+
+Account:
+  agentEnableDexAbstraction  (no params)
+  approveAgent            --agentAddress <address> [--agentName <string>]
+  approveBuilderFee       --maxFeeRate <number> --builder <address>
+  evmUserModify           --usingBigBlocks <bool>
+  noop                    (no params)
+  reserveRequestWeight    --weight <number>
+  setDisplayName          --displayName <string>
+  spotUser                --optOut <bool>
+  userDexAbstraction      --user <address> --enabled <bool>
 
 Fund Transfers:
-  withdraw3               --destination <address> --amount <number>
-  usdSend                 --destination <address> --amount <number>
-  spotSend                --destination <address> --token <name:address> --amount <number>
   sendAsset               --destination <address> --token <name:address> --amount <number>
                           --sourceDex <string> --destinationDex <string> [--fromSubAccount <address>]
+  spotSend                --destination <address> --token <name:address> --amount <number>
   usdClassTransfer        --amount <number> --toPerp <bool>
+  usdSend                 --destination <address> --amount <number>
+  withdraw3               --destination <address> --amount <number>
 
-Sub-Account Management:
+Sub-Account:
   createSubAccount        --name <string>
   subAccountModify        --subAccountUser <address> --name <string>
-  subAccountTransfer      --subAccountUser <address> --isDeposit <bool> --usd <number>
-  subAccountSpotTransfer  --subAccountUser <address> --isDeposit <bool> 
+  subAccountSpotTransfer  --subAccountUser <address> --isDeposit <bool>
                           --token <name:address> --amount <number>
+  subAccountTransfer      --subAccountUser <address> --isDeposit <bool> --usd <number>
 
-Vault Operations:
-  createVault             --name <string> --description <string> --initialUsd <number>
-  vaultModify             --vaultAddress <address> [--allowDeposits <bool>] 
-                          [--alwaysCloseOnWithdraw <bool>]
-  vaultTransfer           --vaultAddress <address> --isDeposit <bool> --usd <number>
-  vaultDistribute         --vaultAddress <address> --usd <number>
-
-Agent & Referrer:
-  approveAgent            --agentAddress <address> [--agentName <string>]
-  approveBuilderFee       --maxFeeRate <number> --builder <address>
+Referrer:
+  claimRewards            (no params)
   registerReferrer        --code <string>
   setReferrer             --code <string>
-  setDisplayName          --displayName <string>
 
 Staking & Delegation:
-  tokenDelegate           --validator <address> --wei <number> --isUndelegate <bool>
   cDeposit                --wei <number>
   cWithdraw               --wei <number>
-  claimRewards            (no params)
+  tokenDelegate           --validator <address> --wei <number> --isUndelegate <bool>
 
-Spot & EVM Operations:
-  spotUser                --optOut <bool>
-  evmUserModify           --usingBigBlocks <bool>
-  reserveRequestWeight    --weight <number>
+Vault:
+  createVault             --name <string> --description <string> --initialUsd <number>
+  vaultDistribute         --vaultAddress <address> --usd <number>
+  vaultModify             --vaultAddress <address> [--allowDeposits <bool>]
+                          [--alwaysCloseOnWithdraw <bool>]
+  vaultTransfer           --vaultAddress <address> --isDeposit <bool> --usd <number>
 
 Deploy Market:
   perpDeploy              --registerAsset <json> | --setOracle <json>
   spotDeploy              --genesis <json> | --registerHyperliquidity <json> | --registerSpot <json> |
                           --registerToken2 <json> | --setDeployerTradingFeeShare <json> | --userGenesis <json>
 
-Multi-Sig & Advanced:
-  convertToMultiSigUser   --authorizedUsers <json> --threshold <number>
+Validator Actions:
   cSignerAction           --jailSelf null | --unjailSelf null
   cValidatorAction        --changeProfile <json> | --register <json> | --unregister null
-  noop                    (no params)
+
+Other:
+  convertToMultiSigUser   --authorizedUsers <json> --threshold <number>
 
 =============================================================================
 

package/src/src/api/exchange/agentEnableDexAbstraction.ts

@@ -0,0 +1,96 @@
+import { parser, UnsignedInteger } from "../_base.js";
+import {
+  type ExchangeRequestConfig,
+  executeL1Action,
+  type ExtractRequestOptions,
+  type MultiSignRequestConfig,
+  Signature,
+} from "./_base.js";
+import * as v from "valibot";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Enable HIP-3 DEX abstraction.
+ * @see null
+ */
+export const AgentEnableDexAbstractionRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Action to perform. */
+      action: v.pipe(
+        v.object({
+          /** Type of action. */
+          type: v.pipe(
+            v.literal("agentEnableDexAbstraction"),
+            v.description("Type of action."),
+          ),
+        }),
+        v.description("Action to perform."),
+      ),
+      /** Unique request identifier (current timestamp in ms). */
+      nonce: v.pipe(
+        UnsignedInteger,
+        v.description("Unique request identifier (current timestamp in ms)."),
+      ),
+      /** Cryptographic signature. */
+      signature: v.pipe(
+        Signature,
+        v.description("Cryptographic signature."),
+      ),
+      /** Expiration time of the action. */
+      expiresAfter: v.pipe(
+        v.optional(UnsignedInteger),
+        v.description("Expiration time of the action."),
+      ),
+    }),
+    v.description("Enable HIP-3 DEX abstraction request."),
+  );
+})();
+export type AgentEnableDexAbstractionRequest = v.InferOutput<typeof AgentEnableDexAbstractionRequest>;
+
+import { SuccessResponse } from "./_base.js";
+export { SuccessResponse };
+
+// -------------------- Function --------------------
+
+/** Request options for the {@linkcode agentEnableDexAbstraction} function. */
+export type AgentEnableDexAbstractionOptions = ExtractRequestOptions<
+  v.InferInput<typeof AgentEnableDexAbstractionRequest>
+>;
+
+/**
+ * Enable HIP-3 DEX abstraction.
+ * @param config - General configuration for Exchange API requests.
+ * @param params - Parameters specific to the API request.
+ * @param opts - Request execution options.
+ * @returns Successful response without specific data.
+ *
+ * @throws {ApiRequestError} When the API returns an unsuccessful response.
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { agentEnableDexAbstraction } from "@nktkas/hyperliquid/api/exchange";
+ * import { privateKeyToAccount } from "npm:viem/accounts";
+ *
+ * const wallet = privateKeyToAccount("0x..."); // viem or ethers
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ *
+ * await agentEnableDexAbstraction({ transport, wallet });
+ * ```
+ */
+export async function agentEnableDexAbstraction(
+  config: ExchangeRequestConfig | MultiSignRequestConfig,
+  opts?: AgentEnableDexAbstractionOptions,
+): Promise<SuccessResponse> {
+  const action = parser(AgentEnableDexAbstractionRequest.entries.action)({
+    type: "agentEnableDexAbstraction",
+  });
+  const expiresAfter = typeof config.defaultExpiresAfter === "number"
+    ? config.defaultExpiresAfter
+    : await config.defaultExpiresAfter?.();
+  return await executeL1Action(config, { action, expiresAfter }, opts?.signal);
+}