@tria-sdk/hyperliquid-core 0.1.0

package/dist/api.d.ts

@@ -0,0 +1,279 @@
+/**
+ * Hyperliquid API functions
+ * Platform-agnostic data fetching - no web or React Native specific code
+ */
+import type { HyperliquidNetwork, HyperliquidCandleInterval, HyperliquidCandle, HyperliquidSpotTokenDetails, HyperliquidSpotTokenWithMarketData, HyperliquidPerpMarketData, HyperliquidLatestPrice, HyperliquidRecentTrade, HyperliquidLeverageMode, HyperliquidOrderBookSnapshot, HyperliquidTopOfBook, HyperliquidPosition, HyperliquidOpenOrder, HyperliquidUserState, HyperliquidUserFill, HyperliquidUserFundingUpdate } from "./types";
+type HexAddress = `0x${string}`;
+/**
+ * Retrieves raw spot metadata from Hyperliquid public API
+ */
+export declare function fetchSpotMeta(network?: HyperliquidNetwork): Promise<{
+    universe: {
+        tokens: number[];
+        name: string;
+        index: number;
+        isCanonical: boolean;
+    }[];
+    tokens: {
+        name: string;
+        szDecimals: number;
+        weiDecimals: number;
+        index: number;
+        tokenId: `0x${string}`;
+        isCanonical: boolean;
+        evmContract: {
+            address: `0x${string}`;
+            evm_extra_wei_decimals: number;
+        } | null;
+        fullName: string | null;
+        deployerTradingFeeShare: string;
+    }[];
+}>;
+/**
+ * Fetches token details for a specific token
+ */
+export declare function fetchTokenDetails(tokenId: HexAddress, network?: HyperliquidNetwork): Promise<HyperliquidSpotTokenDetails>;
+/**
+ * Fetches all mid prices
+ */
+export declare function fetchAllMids(network?: HyperliquidNetwork): Promise<Record<string, string>>;
+/**
+ * Fetches spot metadata and asset contexts
+ */
+export declare function fetchSpotMetaAndAssetCtxs(network?: HyperliquidNetwork): Promise<[{
+    universe: {
+        tokens: number[];
+        name: string;
+        index: number;
+        isCanonical: boolean;
+    }[];
+    tokens: {
+        name: string;
+        szDecimals: number;
+        weiDecimals: number;
+        index: number;
+        tokenId: `0x${string}`;
+        isCanonical: boolean;
+        evmContract: {
+            address: `0x${string}`;
+            evm_extra_wei_decimals: number;
+        } | null;
+        fullName: string | null;
+        deployerTradingFeeShare: string;
+    }[];
+}, {
+    prevDayPx: string;
+    dayNtlVlm: string;
+    markPx: string;
+    midPx: string | null;
+    circulatingSupply: string;
+    coin: string;
+    totalSupply: string;
+    dayBaseVlm: string;
+}[]]>;
+/**
+ * Fetches spot tokens with market data
+ */
+export declare function fetchSpotTokensWithMarketData(network?: HyperliquidNetwork): Promise<HyperliquidSpotTokenWithMarketData[]>;
+/**
+ * Fetches spot order book for a token
+ */
+export declare function fetchSpotOrderBook(tokenName: string, network?: HyperliquidNetwork): Promise<{
+    coin: string;
+    time: number;
+    levels: [{
+        px: string;
+        sz: string;
+        n: number;
+    }[], {
+        px: string;
+        sz: string;
+        n: number;
+    }[]];
+} | null>;
+/**
+ * Fetches order book snapshot with normalized levels
+ */
+export declare function fetchOrderBook(symbol: string, depth?: number, network?: HyperliquidNetwork): Promise<HyperliquidOrderBookSnapshot>;
+/**
+ * Fetches recent trades for a coin
+ */
+export declare function fetchRecentTrades(coin: string, limit?: number, network?: HyperliquidNetwork): Promise<HyperliquidRecentTrade[]>;
+/**
+ * Fetches perp metadata
+ */
+export declare function fetchPerpMeta(network?: HyperliquidNetwork): Promise<{
+    universe: {
+        szDecimals: number;
+        name: string;
+        maxLeverage: number;
+        marginTableId: number;
+        onlyIsolated?: true | undefined;
+        isDelisted?: true | undefined;
+        marginMode?: "strictIsolated" | "noCross" | undefined;
+        growthMode?: "enabled" | undefined;
+        lastGrowthModeChangeTime?: string | undefined;
+    }[];
+    marginTables: [number, {
+        description: string;
+        marginTiers: {
+            lowerBound: string;
+            maxLeverage: number;
+        }[];
+    }][];
+    collateralToken: number;
+}>;
+/**
+ * Fetches perp metadata and asset contexts
+ */
+export declare function fetchPerpMetaAndAssetCtxs(network?: HyperliquidNetwork): Promise<[{
+    universe: {
+        szDecimals: number;
+        name: string;
+        maxLeverage: number;
+        marginTableId: number;
+        onlyIsolated?: true | undefined;
+        isDelisted?: true | undefined;
+        marginMode?: "strictIsolated" | "noCross" | undefined;
+        growthMode?: "enabled" | undefined;
+        lastGrowthModeChangeTime?: string | undefined;
+    }[];
+    marginTables: [number, {
+        description: string;
+        marginTiers: {
+            lowerBound: string;
+            maxLeverage: number;
+        }[];
+    }][];
+    collateralToken: number;
+}, {
+    prevDayPx: string;
+    dayNtlVlm: string;
+    markPx: string;
+    midPx: string | null;
+    funding: string;
+    openInterest: string;
+    premium: string | null;
+    oraclePx: string;
+    impactPxs: string[] | null;
+    dayBaseVlm: string;
+}[]]>;
+/**
+ * Fetches funding history for a coin
+ */
+export declare function fetchFundingHistory(coin: string, startTime: number, network?: HyperliquidNetwork): Promise<{
+    coin: string;
+    fundingRate: string;
+    premium: string;
+    time: number;
+}[]>;
+/**
+ * Fetches user fills (trade history)
+ */
+export declare function fetchUserFills(params: {
+    user: string;
+    aggregateByTime?: boolean;
+    limit?: number;
+    network?: HyperliquidNetwork;
+}): Promise<HyperliquidUserFill[]>;
+/**
+ * Fetches user fills within a time window (order history)
+ */
+export declare function fetchUserFillsByTime(params: {
+    user: string;
+    startTime: number;
+    endTime?: number;
+    aggregateByTime?: boolean;
+    limit?: number;
+    network?: HyperliquidNetwork;
+}): Promise<HyperliquidUserFill[]>;
+/**
+ * Fetches user funding ledger updates
+ */
+export declare function fetchUserFunding(params: {
+    user: string;
+    startTime: number;
+    endTime?: number | null;
+    limit?: number;
+    network?: HyperliquidNetwork;
+}): Promise<HyperliquidUserFundingUpdate[]>;
+/**
+ * User non-funding ledger update (deposits, withdrawals, transfers)
+ */
+export interface HyperliquidLedgerUpdate {
+    time: number;
+    hash?: string;
+    delta: {
+        type: string;
+        usdc?: string;
+        amount?: string;
+        fee?: string;
+        nonce?: number;
+        destination?: string;
+        user?: string;
+    };
+}
+/**
+ * Fetches user non-funding ledger updates (deposits, withdrawals, transfers)
+ */
+export declare function fetchUserNonFundingLedgerUpdates(params: {
+    user: string;
+    startTime: number;
+    endTime?: number | null;
+    limit?: number;
+    network?: HyperliquidNetwork;
+}): Promise<HyperliquidLedgerUpdate[]>;
+/**
+ * Fetches perps with market data
+ */
+export declare function fetchPerpsWithMarketData(network?: HyperliquidNetwork): Promise<HyperliquidPerpMarketData[]>;
+/**
+ * Fetches candlestick data
+ */
+export declare function fetchCandlesticks(params: {
+    coin: string;
+    interval: HyperliquidCandleInterval;
+    startTime?: number;
+    endTime?: number;
+    network?: HyperliquidNetwork;
+}): Promise<HyperliquidCandle[]>;
+/**
+ * Fetches spot candles for a token
+ */
+export declare function fetchSpotCandles(params: {
+    tokenName: string;
+    interval: HyperliquidCandleInterval;
+    startTime?: number;
+    endTime?: number;
+    network?: HyperliquidNetwork;
+}): Promise<HyperliquidCandle[]>;
+/**
+ * Fetches latest price for a coin
+ */
+export declare function fetchLatestPrice(coin: string, network?: HyperliquidNetwork): Promise<HyperliquidLatestPrice>;
+/**
+ * Fetches user leverage mode for a specific coin
+ */
+export declare function fetchUserLeverageMode(userAddress: string, coin: string, network?: HyperliquidNetwork): Promise<HyperliquidLeverageMode | null>;
+/**
+ * Fetches top of book (best bid/ask) for a symbol
+ */
+export declare function fetchTopOfBook(symbol: string, network?: HyperliquidNetwork): Promise<HyperliquidTopOfBook>;
+/**
+ * Fetches user positions from clearinghouse state
+ */
+export declare function fetchUserPositions(userAddress: string, network?: HyperliquidNetwork): Promise<HyperliquidPosition[]>;
+/**
+ * Fetches user's clearinghouse state (positions + margin summary)
+ */
+export declare function fetchUserState(userAddress: string, network?: HyperliquidNetwork): Promise<HyperliquidUserState | null>;
+/**
+ * Fetches user's open orders
+ */
+export declare function fetchOpenOrders(userAddress: string, network?: HyperliquidNetwork): Promise<HyperliquidOpenOrder[]>;
+/**
+ * Resolves asset index for a coin
+ */
+export declare function resolveAssetIndex(coin: string, network?: HyperliquidNetwork): Promise<number>;
+export {};
+//# sourceMappingURL=api.d.ts.map

package/dist/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,KAAK,EACV,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,2BAA2B,EAC3B,kCAAkC,EAClC,yBAAyB,EACzB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EAEvB,4BAA4B,EAC5B,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,mBAAmB,EACnB,4BAA4B,EAC7B,MAAM,SAAS,CAAC;AASjB,KAAK,UAAU,GAAG,KAAK,MAAM,EAAE,CAAC;AAoJhC;;GAEG;AACH,wBAAsB,aAAa,CAAC,OAAO,GAAE,kBAA8B;;;;;;;;;;;;;;;;;;;;;GAO1E;AAED;;GAEG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,UAAU,EACnB,OAAO,GAAE,kBAA8B,GACtC,OAAO,CAAC,2BAA2B,CAAC,CAqBtC;AAED;;GAEG;AACH,wBAAsB,YAAY,CAChC,OAAO,GAAE,kBAA8B,GACtC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAOjC;AAED;;GAEG;AACH,wBAAsB,yBAAyB,CAC7C,OAAO,GAAE,kBAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAQxC;AAED;;GAEG;AACH,wBAAsB,6BAA6B,CACjD,OAAO,GAAE,kBAA8B,GACtC,OAAO,CAAC,kCAAkC,EAAE,CAAC,CAwD/C;AAED;;GAEG;AACH,wBAAsB,kBAAkB,CACtC,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,kBAA8B;;;;;;;;;;;;UASxC;AAED;;GAEG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,MAAM,EACd,KAAK,SAAK,EACV,OAAO,GAAE,kBAA8B,GACtC,OAAO,CAAC,4BAA4B,CAAC,CA2CvC;AAED;;GAEG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,MAAM,EACZ,KAAK,SAAK,EACV,OAAO,GAAE,kBAA8B,GACtC,OAAO,CAAC,sBAAsB,EAAE,CAAC,CAkCnC;AAED;;GAEG;AACH,wBAAsB,aAAa,CAAC,OAAO,GAAE,kBAA8B;;;;;;oBA1G7B,CAAC;kBAChB,CAAC;kBACR,CAAC;kBAMxB,CAAC;gCAED,CAAC;;;;;;;;;;GAuGD;AAED;;GAEG;AACH,wBAAsB,yBAAyB,CAC7C,OAAO,GAAE,kBAA8B;;;;;;oBAuDrC,CAAJ;kBAGM,CAAN;kBAAsC,CAAC;kBAEzB,CAAA;gCACK,CAAC;;;;;;;;;;;;;;;;;;;;;MArDnB;AAED;;GAEG;AACH,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,kBAA8B;;;;;KAQxC;AAED;;GAEG;AACH,wBAAsB,cAAc,CAAC,MAAM,EAAE;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAiDjC;AAED;;GAEG;AACH,wBAAsB,oBAAoB,CAAC,MAAM,EAAE;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAyDjC;AAED;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,MAAM,EAAE;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B,GAAG,OAAO,CAAC,4BAA4B,EAAE,CAAC,CA0B1C;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;GAEG;AACH,wBAAsB,gCAAgC,CAAC,MAAM,EAAE;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B,GAAG,OAAO,CAAC,uBAAuB,EAAE,CAAC,CA8BrC;AAED;;GAEG;AACH,wBAAsB,wBAAwB,CAC5C,OAAO,GAAE,kBAA8B,GACtC,OAAO,CAAC,yBAAyB,EAAE,CAAC,CA0EtC;AAED;;GAEG;AACH,wBAAsB,iBAAiB,CAAC,MAAM,EAAE;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,yBAAyB,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAmC/B;AAED;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,MAAM,EAAE;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,yBAAyB,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAU/B;AAED;;GAEG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,kBAA8B,GACtC,OAAO,CAAC,sBAAsB,CAAC,CAiEjC;AAED;;GAEG;AACH,wBAAsB,qBAAqB,CACzC,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,kBAA8B,GACtC,OAAO,CAAC,uBAAuB,GAAG,IAAI,CAAC,CAmCzC;AAED;;GAEG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,kBAA8B,GACtC,OAAO,CAAC,oBAAoB,CAAC,CA6B/B;AAMD;;GAEG;AACH,wBAAsB,kBAAkB,CACtC,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,kBAA8B,GACtC,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAoChC;AAED;;GAEG;AACH,wBAAsB,cAAc,CAClC,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,kBAA8B,GACtC,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CA2DtC;AAED;;GAEG;AACH,wBAAsB,eAAe,CACnC,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,kBAA8B,GACtC,OAAO,CAAC,oBAAoB,EAAE,CAAC,CA4BjC;AAMD;;GAEG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,kBAA8B,GACtC,OAAO,CAAC,MAAM,CAAC,CAmBjB"}