@nktkas/hyperliquid/script/src/api/info/_methods/gossipRootIps.d.ts

Hyperliquid API SDK for all major JS runtimes, written in TypeScript.

import * as v from "valibot";
/**
 * Request gossip root IPs.
 */
export declare const GossipRootIpsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
    /** Type of request. */
    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"gossipRootIps", undefined>, v.DescriptionAction<"gossipRootIps", "Type of request.">]>;
}, undefined>, v.DescriptionAction<{
    type: "gossipRootIps";
}, "Request gossip root IPs.">]>;
export type GossipRootIpsRequest = v.InferOutput<typeof GossipRootIpsRequest>;
/**
 * Array of gossip root IPs.
 */
export declare const GossipRootIpsResponse: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.Ipv4Action<string, undefined>]>, undefined>, v.DescriptionAction<string[], "Array of gossip root IPs.">]>;
export type GossipRootIpsResponse = v.InferOutput<typeof GossipRootIpsResponse>;
import type { InfoConfig } from "./_types.js";
/**
 * Request gossip root IPs.
 *
 * @param config - General configuration for Info API requests.
 * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
 *
 * @returns Array of gossip root IPs.
 *
 * @throws {ValiError} When the request parameters fail validation (before sending).
 * @throws {TransportError} When the transport layer throws an error.
 *
 * @example
 * ```ts
 * import { HttpTransport } from "@nktkas/hyperliquid";
 * import { gossipRootIps } from "@nktkas/hyperliquid/api/info";
 *
 * const transport = new HttpTransport(); // or `WebSocketTransport`
 *
 * const data = await gossipRootIps({ transport });
 * ```
 */
export declare function gossipRootIps(config: InfoConfig, signal?: AbortSignal): Promise<GossipRootIpsResponse>;
//# sourceMappingURL=gossipRootIps.d.ts.map