@basedone/core 0.1.8 → 0.2.0

package/dist/chunk-4UEJOM6W.mjs

@@ -4,6 +4,4 @@ var __glob = (map) => (path) => {
   throw new Error("Module not found in bundle: " + path);
 };
 
-export {
-  __glob
-};
+export { __glob };

package/dist/chunk-VBC6EQ7Q.mjs

@@ -0,0 +1,235 @@
+// lib/instrument/client.ts
+var AssetIdUtils = {
+  /**
+   * Calculate perp asset ID
+   * - Root dex: assetIndex (0, 1, 2, ...)
+   * - HIP3 dex: 100000 + dexIndex * 10000 + assetIndex
+   */
+  calcPerpAssetId(dexIndex, assetIndex) {
+    if (dexIndex === 0) return assetIndex;
+    return 1e5 + dexIndex * 1e4 + assetIndex;
+  },
+  /**
+   * Calculate spot asset ID: 10000 + pairIndex
+   */
+  calcSpotAssetId(pairIndex) {
+    return 1e4 + pairIndex;
+  },
+  /**
+   * Check if symbol is HIP3 format (contains ":")
+   */
+  isHip3Symbol(symbol) {
+    return symbol?.includes(":") ?? false;
+  },
+  /**
+   * Extract dex name from HIP3 symbol (e.g., "xyz:MSTR" -> "xyz")
+   */
+  extractDexName(symbol) {
+    if (!this.isHip3Symbol(symbol)) return void 0;
+    return symbol.split(":")[0];
+  }
+};
+var InstrumentClient = class {
+  constructor(spotMeta, allPerpsMeta) {
+    this.spotMeta = spotMeta;
+    this.allPerpsMeta = allPerpsMeta;
+    this.instruments = [];
+    // O(1) lookup maps for efficient retrieval
+    this.instrumentsBySymbol = /* @__PURE__ */ new Map();
+    this.instrumentsByCoin = /* @__PURE__ */ new Map();
+    this.instrumentsByAssetId = /* @__PURE__ */ new Map();
+    // Additional spot lookups (base token -> instrument)
+    this.spotByBaseToken = /* @__PURE__ */ new Map();
+    // Dex metadata map (dex name -> PerpsMeta)
+    // Key: "" for root dex, dex name for HIP3 (e.g., "xyz")
+    this.dexMetaMap = /* @__PURE__ */ new Map();
+    // Token index lookup for spot
+    this.spotTokensByIndex = /* @__PURE__ */ new Map();
+  }
+  /**
+   * Initialize the client by processing meta into instruments.
+   * Call this after construction to populate the instrument registry.
+   * @returns this for chaining
+   */
+  init() {
+    if (!this.spotMeta || !this.allPerpsMeta) {
+      throw new Error("SpotMeta and allPerpsMeta are required");
+    }
+    this.indexSpotTokens();
+    this.processPerpsInstruments();
+    this.processSpotInstruments();
+    return this;
+  }
+  // ===== Perps Meta Accessors =====
+  getAllPerpsMeta() {
+    return this.allPerpsMeta;
+  }
+  /**
+   * Get PerpsMeta for a specific dex
+   * @param dex - Dex name ("" for root dex, or HIP3 dex name)
+   */
+  getPerpDex(dex) {
+    return this.dexMetaMap.get(dex);
+  }
+  /**
+   * Get PerpsMeta by dex index in allPerpsMeta array
+   */
+  getPerpDexByIndex(index) {
+    return this.allPerpsMeta[index];
+  }
+  // ===== Instrument Accessors =====
+  /**
+   * Get all instruments
+   */
+  getAllInstruments() {
+    return this.instruments;
+  }
+  /**
+   * Get all perps instruments
+   */
+  getPerpsInstruments() {
+    return this.instruments.filter(
+      (i) => i.type === "futures"
+    );
+  }
+  getHip3Instruments() {
+    return this.instruments.filter(
+      (i) => i.type === "futures" && !!i.dex
+    );
+  }
+  /**
+   * Get all spot instruments
+   */
+  getSpotInstruments() {
+    return this.instruments.filter(
+      (i) => i.type === "spot"
+    );
+  }
+  /**
+   * Get instrument by symbol or coin (tries both)
+   * @param coinOrSymbol - Symbol (e.g., "BTC", "BTC/USDC") or coin (e.g., "@107")
+   */
+  getInstrument(coinOrSymbol) {
+    return this.instrumentsByCoin.get(coinOrSymbol) ?? this.instrumentsBySymbol.get(coinOrSymbol);
+  }
+  /**
+   * Get instrument by display symbol
+   * @param symbol - Display symbol (e.g., "BTC", "BTC/USDC", "xyz:MSTR")
+   */
+  getInstrumentBySymbol(symbol) {
+    return this.instrumentsBySymbol.get(symbol);
+  }
+  /**
+   * Get instrument by Hyperliquid API coin format
+   * @param coin - API coin name (e.g., "BTC", "@107", "xyz:MSTR")
+   */
+  getInstrumentByCoin(coin) {
+    return this.instrumentsByCoin.get(coin);
+  }
+  /**
+   * Get instrument by asset ID
+   * @param assetId - Numeric asset ID (e.g., 1 for perps, 10001 for spot)
+   */
+  getInstrumentByAssetId(assetId) {
+    return this.instrumentsByAssetId.get(assetId);
+  }
+  /**
+   * Get spot instrument by base token symbol
+   * @param baseSymbol - Base token symbol (e.g., "HYPE" to find "HYPE/USDC")
+   */
+  getSpotInstrumentByBaseToken(baseSymbol) {
+    return this.spotByBaseToken.get(baseSymbol);
+  }
+  /** Search instruments by symbol, coin, or assetId */
+  searchInstruments(query, type) {
+    return this.instruments.filter((i) => {
+      if (type && i.type !== type) return false;
+      return i.symbol.toLowerCase().includes(query.toLowerCase()) || i.coin.toLowerCase().includes(query.toLowerCase());
+    });
+  }
+  /**
+   * Get spot token by index
+   */
+  getSpotToken(index) {
+    return this.spotTokensByIndex.get(index);
+  }
+  // ===== Internal Processing =====
+  indexSpotTokens() {
+    for (const token of this.spotMeta.tokens) {
+      this.spotTokensByIndex.set(token.index, token);
+    }
+  }
+  processPerpsInstruments() {
+    for (let dexIndex = 0; dexIndex < this.allPerpsMeta.length; dexIndex++) {
+      const perpMeta = this.allPerpsMeta[dexIndex];
+      const dexName = this.extractDexNameFromMeta(perpMeta, dexIndex);
+      this.dexMetaMap.set(dexName, perpMeta);
+      const collateralToken = this.spotTokensByIndex.get(
+        perpMeta.collateralToken
+      );
+      const collateralTokenSymbol = collateralToken?.name ?? "USDC";
+      for (let assetIndex = 0; assetIndex < perpMeta.universe.length; assetIndex++) {
+        const info = perpMeta.universe[assetIndex];
+        const assetId = AssetIdUtils.calcPerpAssetId(dexIndex, assetIndex);
+        const instrument = {
+          assetId,
+          symbol: info.name,
+          coin: info.name,
+          szDecimals: info.szDecimals,
+          leverage: info.maxLeverage,
+          collateralTokenSymbol,
+          type: "futures",
+          isDelisted: info.isDelisted,
+          dex: AssetIdUtils.extractDexName(info.name),
+          collateralTokenIndex: perpMeta.collateralToken
+        };
+        this.addInstrument(instrument);
+      }
+    }
+  }
+  processSpotInstruments() {
+    const seenSymbols = /* @__PURE__ */ new Set();
+    for (const pair of this.spotMeta.universe) {
+      const [baseTokenIndex, quoteTokenIndex] = pair.tokens;
+      const baseToken = this.spotTokensByIndex.get(baseTokenIndex);
+      const quoteToken = this.spotTokensByIndex.get(quoteTokenIndex);
+      if (!baseToken || !quoteToken) continue;
+      const symbol = `${baseToken.name}/${quoteToken.name}`;
+      if (seenSymbols.has(symbol)) continue;
+      seenSymbols.add(symbol);
+      const assetId = AssetIdUtils.calcSpotAssetId(pair.index);
+      const instrument = {
+        assetId,
+        symbol,
+        coin: pair.name,
+        // e.g., "@107"
+        szDecimals: baseToken.szDecimals,
+        type: "spot",
+        baseToken,
+        quoteToken
+      };
+      this.addInstrument(instrument);
+      if (!this.spotByBaseToken.has(baseToken.name)) {
+        this.spotByBaseToken.set(baseToken.name, instrument);
+      }
+    }
+  }
+  addInstrument(instrument) {
+    this.instruments.push(instrument);
+    this.instrumentsBySymbol.set(instrument.symbol, instrument);
+    this.instrumentsByCoin.set(instrument.coin, instrument);
+    this.instrumentsByAssetId.set(instrument.assetId, instrument);
+  }
+  /**
+   * Extract dex name from PerpsMeta
+   * Root dex (index 0) returns "", HIP3 dexes return the dex name (e.g., "xyz")
+   */
+  extractDexNameFromMeta(perpMeta, dexIndex) {
+    if (dexIndex === 0) return "";
+    const firstAsset = perpMeta.universe[0];
+    if (!firstAsset) return "";
+    return AssetIdUtils.extractDexName(firstAsset.name) ?? "";
+  }
+};
+
+export { AssetIdUtils, InstrumentClient };

package/dist/client-CgmiTuEX.d.mts

@@ -0,0 +1,179 @@
+import { MarginTables, PerpsAssetCtx, InfoClient, SpotToken, SpotMeta } from '@nktkas/hyperliquid';
+
+interface PerpsMeta {
+    collateralToken: number;
+    /** Trading universes available for perpetual trading. */
+    universe: PerpsUniverse[];
+    /** Margin requirement tables for different leverage tiers. */
+    marginTables: MarginTables;
+}
+/** Metadata and context for perpetual assets. */
+type PerpsMetaAndAssetCtxs = [
+    /** Metadata for assets. */
+    PerpsMeta,
+    /** Context for each perpetual asset. */
+    PerpsAssetCtx[]
+];
+/** Trading universe parameters for perpetual assets. */
+interface PerpsUniverse {
+    /** Minimum decimal places for order sizes. */
+    szDecimals: number;
+    /** Name of the universe. */
+    name: string;
+    /** Maximum allowed leverage. */
+    maxLeverage: number;
+    /** Unique identifier for the margin requirements table. */
+    marginTableId: number;
+    /** Indicates if only isolated margin trading is allowed. */
+    onlyIsolated?: true;
+    /** Indicates if the universe is delisted. */
+    isDelisted?: true;
+    /** Indicates if the universe is in growth mode, eligible for discounted fees */
+    growthMode?: "enabled";
+    /** Margin mode for the universe. */
+    marginMode?: "strictIsolated" | "noCross";
+}
+type AllPerpsMeta = PerpsMeta[];
+declare function getAllPerpsMeta(infoClient: InfoClient): Promise<AllPerpsMeta>;
+
+interface BaseInstrument {
+    assetId: number;
+    symbol: string;
+    coin: string;
+    szDecimals: number;
+    type: "spot" | "futures";
+    isDelisted?: boolean;
+}
+interface PerpsInstrument extends BaseInstrument {
+    type: "futures";
+    leverage: number;
+    collateralTokenSymbol: string;
+    dex?: string;
+    collateralTokenIndex?: number;
+}
+interface SpotInstrument extends BaseInstrument {
+    type: "spot";
+    baseToken: SpotToken;
+    quoteToken: SpotToken;
+}
+type MarketInstrument = PerpsInstrument | SpotInstrument;
+/**
+ * Asset ID calculation utilities
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/asset-ids
+ */
+declare const AssetIdUtils: {
+    /**
+     * Calculate perp asset ID
+     * - Root dex: assetIndex (0, 1, 2, ...)
+     * - HIP3 dex: 100000 + dexIndex * 10000 + assetIndex
+     */
+    calcPerpAssetId(dexIndex: number, assetIndex: number): number;
+    /**
+     * Calculate spot asset ID: 10000 + pairIndex
+     */
+    calcSpotAssetId(pairIndex: number): number;
+    /**
+     * Check if symbol is HIP3 format (contains ":")
+     */
+    isHip3Symbol(symbol: string): boolean;
+    /**
+     * Extract dex name from HIP3 symbol (e.g., "xyz:MSTR" -> "xyz")
+     */
+    extractDexName(symbol: string): string | undefined;
+};
+/**
+ * Hyperliquid Instrument Client
+ *
+ * Processes spotMeta and allPerpsMeta into a unified instrument registry
+ * with O(1) lookups by symbol, coin, or assetId.
+ *
+ * Usage:
+ * ```ts
+ * const client = new InstrumentClient(spotMeta, allPerpsMeta).init();
+ * const btc = client.getInstrument("BTC");
+ * const spot = client.getInstrumentByAssetId(10001);
+ * ```
+ */
+declare class InstrumentClient {
+    spotMeta: SpotMeta;
+    allPerpsMeta: AllPerpsMeta;
+    private instruments;
+    private instrumentsBySymbol;
+    private instrumentsByCoin;
+    private instrumentsByAssetId;
+    private spotByBaseToken;
+    private dexMetaMap;
+    private spotTokensByIndex;
+    constructor(spotMeta: SpotMeta, allPerpsMeta: AllPerpsMeta);
+    /**
+     * Initialize the client by processing meta into instruments.
+     * Call this after construction to populate the instrument registry.
+     * @returns this for chaining
+     */
+    init(): this;
+    getAllPerpsMeta(): AllPerpsMeta;
+    /**
+     * Get PerpsMeta for a specific dex
+     * @param dex - Dex name ("" for root dex, or HIP3 dex name)
+     */
+    getPerpDex(dex: string): PerpsMeta | undefined;
+    /**
+     * Get PerpsMeta by dex index in allPerpsMeta array
+     */
+    getPerpDexByIndex(index: number): PerpsMeta | undefined;
+    /**
+     * Get all instruments
+     */
+    getAllInstruments(): MarketInstrument[];
+    /**
+     * Get all perps instruments
+     */
+    getPerpsInstruments(): PerpsInstrument[];
+    getHip3Instruments(): PerpsInstrument[];
+    /**
+     * Get all spot instruments
+     */
+    getSpotInstruments(): SpotInstrument[];
+    /**
+     * Get instrument by symbol or coin (tries both)
+     * @param coinOrSymbol - Symbol (e.g., "BTC", "BTC/USDC") or coin (e.g., "@107")
+     */
+    getInstrument(coinOrSymbol: string): MarketInstrument | undefined;
+    /**
+     * Get instrument by display symbol
+     * @param symbol - Display symbol (e.g., "BTC", "BTC/USDC", "xyz:MSTR")
+     */
+    getInstrumentBySymbol(symbol: string): MarketInstrument | undefined;
+    /**
+     * Get instrument by Hyperliquid API coin format
+     * @param coin - API coin name (e.g., "BTC", "@107", "xyz:MSTR")
+     */
+    getInstrumentByCoin(coin: string): MarketInstrument | undefined;
+    /**
+     * Get instrument by asset ID
+     * @param assetId - Numeric asset ID (e.g., 1 for perps, 10001 for spot)
+     */
+    getInstrumentByAssetId(assetId: number): MarketInstrument | undefined;
+    /**
+     * Get spot instrument by base token symbol
+     * @param baseSymbol - Base token symbol (e.g., "HYPE" to find "HYPE/USDC")
+     */
+    getSpotInstrumentByBaseToken(baseSymbol: string): SpotInstrument | undefined;
+    /** Search instruments by symbol, coin, or assetId */
+    searchInstruments(query: string, type?: "spot" | "futures"): MarketInstrument[];
+    /**
+     * Get spot token by index
+     */
+    getSpotToken(index: number): SpotToken | undefined;
+    private indexSpotTokens;
+    private processPerpsInstruments;
+    private processSpotInstruments;
+    private addInstrument;
+    /**
+     * Extract dex name from PerpsMeta
+     * Root dex (index 0) returns "", HIP3 dexes return the dex name (e.g., "xyz")
+     */
+    private extractDexNameFromMeta;
+}
+
+export { type AllPerpsMeta as A, type BaseInstrument as B, InstrumentClient as I, type MarketInstrument as M, type PerpsMeta as P, type SpotInstrument as S, type PerpsMetaAndAssetCtxs as a, type PerpsUniverse as b, type PerpsInstrument as c, AssetIdUtils as d, getAllPerpsMeta as g };

package/dist/client-CgmiTuEX.d.ts

@@ -0,0 +1,179 @@
+import { MarginTables, PerpsAssetCtx, InfoClient, SpotToken, SpotMeta } from '@nktkas/hyperliquid';
+
+interface PerpsMeta {
+    collateralToken: number;
+    /** Trading universes available for perpetual trading. */
+    universe: PerpsUniverse[];
+    /** Margin requirement tables for different leverage tiers. */
+    marginTables: MarginTables;
+}
+/** Metadata and context for perpetual assets. */
+type PerpsMetaAndAssetCtxs = [
+    /** Metadata for assets. */
+    PerpsMeta,
+    /** Context for each perpetual asset. */
+    PerpsAssetCtx[]
+];
+/** Trading universe parameters for perpetual assets. */
+interface PerpsUniverse {
+    /** Minimum decimal places for order sizes. */
+    szDecimals: number;
+    /** Name of the universe. */
+    name: string;
+    /** Maximum allowed leverage. */
+    maxLeverage: number;
+    /** Unique identifier for the margin requirements table. */
+    marginTableId: number;
+    /** Indicates if only isolated margin trading is allowed. */
+    onlyIsolated?: true;
+    /** Indicates if the universe is delisted. */
+    isDelisted?: true;
+    /** Indicates if the universe is in growth mode, eligible for discounted fees */
+    growthMode?: "enabled";
+    /** Margin mode for the universe. */
+    marginMode?: "strictIsolated" | "noCross";
+}
+type AllPerpsMeta = PerpsMeta[];
+declare function getAllPerpsMeta(infoClient: InfoClient): Promise<AllPerpsMeta>;
+
+interface BaseInstrument {
+    assetId: number;
+    symbol: string;
+    coin: string;
+    szDecimals: number;
+    type: "spot" | "futures";
+    isDelisted?: boolean;
+}
+interface PerpsInstrument extends BaseInstrument {
+    type: "futures";
+    leverage: number;
+    collateralTokenSymbol: string;
+    dex?: string;
+    collateralTokenIndex?: number;
+}
+interface SpotInstrument extends BaseInstrument {
+    type: "spot";
+    baseToken: SpotToken;
+    quoteToken: SpotToken;
+}
+type MarketInstrument = PerpsInstrument | SpotInstrument;
+/**
+ * Asset ID calculation utilities
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/asset-ids
+ */
+declare const AssetIdUtils: {
+    /**
+     * Calculate perp asset ID
+     * - Root dex: assetIndex (0, 1, 2, ...)
+     * - HIP3 dex: 100000 + dexIndex * 10000 + assetIndex
+     */
+    calcPerpAssetId(dexIndex: number, assetIndex: number): number;
+    /**
+     * Calculate spot asset ID: 10000 + pairIndex
+     */
+    calcSpotAssetId(pairIndex: number): number;
+    /**
+     * Check if symbol is HIP3 format (contains ":")
+     */
+    isHip3Symbol(symbol: string): boolean;
+    /**
+     * Extract dex name from HIP3 symbol (e.g., "xyz:MSTR" -> "xyz")
+     */
+    extractDexName(symbol: string): string | undefined;
+};
+/**
+ * Hyperliquid Instrument Client
+ *
+ * Processes spotMeta and allPerpsMeta into a unified instrument registry
+ * with O(1) lookups by symbol, coin, or assetId.
+ *
+ * Usage:
+ * ```ts
+ * const client = new InstrumentClient(spotMeta, allPerpsMeta).init();
+ * const btc = client.getInstrument("BTC");
+ * const spot = client.getInstrumentByAssetId(10001);
+ * ```
+ */
+declare class InstrumentClient {
+    spotMeta: SpotMeta;
+    allPerpsMeta: AllPerpsMeta;
+    private instruments;
+    private instrumentsBySymbol;
+    private instrumentsByCoin;
+    private instrumentsByAssetId;
+    private spotByBaseToken;
+    private dexMetaMap;
+    private spotTokensByIndex;
+    constructor(spotMeta: SpotMeta, allPerpsMeta: AllPerpsMeta);
+    /**
+     * Initialize the client by processing meta into instruments.
+     * Call this after construction to populate the instrument registry.
+     * @returns this for chaining
+     */
+    init(): this;
+    getAllPerpsMeta(): AllPerpsMeta;
+    /**
+     * Get PerpsMeta for a specific dex
+     * @param dex - Dex name ("" for root dex, or HIP3 dex name)
+     */
+    getPerpDex(dex: string): PerpsMeta | undefined;
+    /**
+     * Get PerpsMeta by dex index in allPerpsMeta array
+     */
+    getPerpDexByIndex(index: number): PerpsMeta | undefined;
+    /**
+     * Get all instruments
+     */
+    getAllInstruments(): MarketInstrument[];
+    /**
+     * Get all perps instruments
+     */
+    getPerpsInstruments(): PerpsInstrument[];
+    getHip3Instruments(): PerpsInstrument[];
+    /**
+     * Get all spot instruments
+     */
+    getSpotInstruments(): SpotInstrument[];
+    /**
+     * Get instrument by symbol or coin (tries both)
+     * @param coinOrSymbol - Symbol (e.g., "BTC", "BTC/USDC") or coin (e.g., "@107")
+     */
+    getInstrument(coinOrSymbol: string): MarketInstrument | undefined;
+    /**
+     * Get instrument by display symbol
+     * @param symbol - Display symbol (e.g., "BTC", "BTC/USDC", "xyz:MSTR")
+     */
+    getInstrumentBySymbol(symbol: string): MarketInstrument | undefined;
+    /**
+     * Get instrument by Hyperliquid API coin format
+     * @param coin - API coin name (e.g., "BTC", "@107", "xyz:MSTR")
+     */
+    getInstrumentByCoin(coin: string): MarketInstrument | undefined;
+    /**
+     * Get instrument by asset ID
+     * @param assetId - Numeric asset ID (e.g., 1 for perps, 10001 for spot)
+     */
+    getInstrumentByAssetId(assetId: number): MarketInstrument | undefined;
+    /**
+     * Get spot instrument by base token symbol
+     * @param baseSymbol - Base token symbol (e.g., "HYPE" to find "HYPE/USDC")
+     */
+    getSpotInstrumentByBaseToken(baseSymbol: string): SpotInstrument | undefined;
+    /** Search instruments by symbol, coin, or assetId */
+    searchInstruments(query: string, type?: "spot" | "futures"): MarketInstrument[];
+    /**
+     * Get spot token by index
+     */
+    getSpotToken(index: number): SpotToken | undefined;
+    private indexSpotTokens;
+    private processPerpsInstruments;
+    private processSpotInstruments;
+    private addInstrument;
+    /**
+     * Extract dex name from PerpsMeta
+     * Root dex (index 0) returns "", HIP3 dexes return the dex name (e.g., "xyz")
+     */
+    private extractDexNameFromMeta;
+}
+
+export { type AllPerpsMeta as A, type BaseInstrument as B, InstrumentClient as I, type MarketInstrument as M, type PerpsMeta as P, type SpotInstrument as S, type PerpsMetaAndAssetCtxs as a, type PerpsUniverse as b, type PerpsInstrument as c, AssetIdUtils as d, getAllPerpsMeta as g };