@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
46 lines (45 loc) • 1.64 kB
TypeScript
/**
* This module re-exports all explorer-related API request functions and types.
*
* You can use raw functions to maximize tree-shaking in your app,
* or to access {@link https://github.com/fabian-hiller/valibot | valibot} schemas Request/Response.
*
* @example
* ```ts
* import { HttpTransport } from "@nktkas/hyperliquid";
* import { blockDetails } from "@nktkas/hyperliquid/api/explorer";
* // ^^^^^^^^^^^^
* // same name as in `ExplorerClient`
*
* const transport = new HttpTransport(); // only `HttpTransport` supports this API
*
* const data = await blockDetails(
* { transport }, // same params as in `ExplorerClient`
* { height: 123 },
* );
* ```
* @example
* ```ts
* import { WebSocketTransport } from "@nktkas/hyperliquid";
* import { explorerBlock } from "@nktkas/hyperliquid/api/explorer";
* // ^^^^^^^^^^^^^
* // same name as in `ExplorerClient`
*
* const transport = new WebSocketTransport({ url: "wss://rpc.hyperliquid.xyz/ws" }); // only `WebSocketTransport` supports this API
*
* await explorerBlock(
* { transport }, // same params as in `ExplorerClient`
* (data) => console.log(data),
* );
* ```
*
* @module
*/
/// <amd-module name="file:///home/runner/work/hyperliquid/hyperliquid/src/api/explorer/mod.ts" />
export { ApiRequestError } from "./_methods/_base/mod.js";
export type { ExplorerConfig } from "./_methods/_base/mod.js";
export * from "./_methods/blockDetails.js";
export * from "./_methods/explorerBlock.js";
export * from "./_methods/explorerTxs.js";
export * from "./_methods/txDetails.js";
export * from "./_methods/userDetails.js";