@nktkas/hyperliquid 0.25.0-beta.4 → 0.25.0

package/src/src/api/info/delegatorSummary.ts

@@ -0,0 +1,100 @@
+import * as v from "valibot";
+import { Address, type DeepImmutable, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request user's staking summary.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
+ */
+export const DelegatorSummaryRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("delegatorSummary"),
+        v.description("Type of request."),
+      ),
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+    }),
+    v.description("Request user's staking summary."),
+  );
+})();
+export type DelegatorSummaryRequest = v.InferOutput<typeof DelegatorSummaryRequest>;
+
+/**
+ * User's staking summary.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
+ */
+export const DelegatorSummaryResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Total amount of delegated tokens. */
+      delegated: v.pipe(
+        UnsignedDecimal,
+        v.description("Total amount of delegated tokens."),
+      ),
+      /** Total amount of undelegated tokens. */
+      undelegated: v.pipe(
+        UnsignedDecimal,
+        v.description("Total amount of undelegated tokens."),
+      ),
+      /** Total amount of tokens pending withdrawal. */
+      totalPendingWithdrawal: v.pipe(
+        UnsignedDecimal,
+        v.description("Total amount of tokens pending withdrawal."),
+      ),
+      /** Number of pending withdrawals. */
+      nPendingWithdrawals: v.pipe(
+        UnsignedInteger,
+        v.description("Number of pending withdrawals."),
+      ),
+    }),
+    v.description("User's staking summary."),
+  );
+})();
+export type DelegatorSummaryResponse = v.InferOutput<typeof DelegatorSummaryResponse>;
+
+// -------------------- Function --------------------
+
+/** Request parameters for the {@linkcode delegatorSummary} function. */
+export type DelegatorSummaryParameters = Omit<v.InferInput<typeof DelegatorSummaryRequest>, "type">;
+
+/**
+ * Request user's staking summary.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns User's staking summary.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-staking-summary
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { delegatorSummary } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await delegatorSummary(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function delegatorSummary(
+  config: InfoRequestConfig,
+  params: DeepImmutable<DelegatorSummaryParameters>,
+  signal?: AbortSignal,
+): Promise<DelegatorSummaryResponse> {
+  const request = parser(DelegatorSummaryRequest)({
+    type: "delegatorSummary",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/src/api/info/exchangeStatus.ts

@@ -0,0 +1,74 @@
+import * as v from "valibot";
+import { parser, UnsignedInteger } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request exchange system status information.
+ * @see null
+ */
+export const ExchangeStatusRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("exchangeStatus"),
+        v.description("Type of request."),
+      ),
+    }),
+    v.description("Request exchange system status information."),
+  );
+})();
+export type ExchangeStatusRequest = v.InferOutput<typeof ExchangeStatusRequest>;
+
+/**
+ * Exchange system status information.
+ * @see null
+ */
+export const ExchangeStatusResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Server time (in ms since epoch). */
+      time: v.pipe(
+        UnsignedInteger,
+        v.description("Server time (in ms since epoch)."),
+      ),
+      specialStatuses: v.pipe(
+        v.union([v.unknown(), v.null()]),
+      ),
+    }),
+    v.description("Exchange system status information."),
+  );
+})();
+export type ExchangeStatusResponse = v.InferOutput<typeof ExchangeStatusResponse>;
+
+// -------------------- Function --------------------
+
+/**
+ * Request exchange system status information.
+ * @param config - General configuration for Info API requests.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Exchange system status information.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { exchangeStatus } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await exchangeStatus({ transport });
+ * ```
+ */
+export function exchangeStatus(
+  config: InfoRequestConfig,
+  signal?: AbortSignal,
+): Promise<ExchangeStatusResponse> {
+  const request = parser(ExchangeStatusRequest)({
+    type: "exchangeStatus",
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/src/api/info/extraAgents.ts

@@ -0,0 +1,102 @@
+import * as v from "valibot";
+import { Address, type DeepImmutable, parser, UnsignedInteger } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request user extra agents.
+ * @see null
+ */
+export const ExtraAgentsRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("extraAgents"),
+        v.description("Type of request."),
+      ),
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+    }),
+    v.description("Request user extra agents."),
+  );
+})();
+export type ExtraAgentsRequest = v.InferOutput<typeof ExtraAgentsRequest>;
+
+/**
+ * Array of extra agent details for a user.
+ * @see null
+ */
+export const ExtraAgentsResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.array(
+      /** Extra agent details for a user. */
+      v.pipe(
+        v.object({
+          /** Extra agent address. */
+          address: v.pipe(
+            Address,
+            v.description("Extra agent address."),
+          ),
+          /** Extra agent name. */
+          name: v.pipe(
+            v.string(),
+            v.minLength(1),
+            v.description("Extra agent name."),
+          ),
+          /** Validity period as a timestamp (in ms since epoch). */
+          validUntil: v.pipe(
+            UnsignedInteger,
+            v.description("Validity period as a timestamp (in ms since epoch)."),
+          ),
+        }),
+        v.description("Extra agent details for a user."),
+      ),
+    ),
+    v.description("Array of extra agent details for a user."),
+  );
+})();
+export type ExtraAgentsResponse = v.InferOutput<typeof ExtraAgentsResponse>;
+
+// -------------------- Function --------------------
+
+/** Request parameters for the {@linkcode extraAgents} function. */
+export type ExtraAgentsParameters = Omit<v.InferInput<typeof ExtraAgentsRequest>, "type">;
+
+/**
+ * Request user extra agents.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of extra agent details for a user.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { extraAgents } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await extraAgents(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function extraAgents(
+  config: InfoRequestConfig,
+  params: DeepImmutable<ExtraAgentsParameters>,
+  signal?: AbortSignal,
+): Promise<ExtraAgentsResponse> {
+  const request = parser(ExtraAgentsRequest)({
+    type: "extraAgents",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/src/api/info/frontendOpenOrders.ts

@@ -0,0 +1,219 @@
+import * as v from "valibot";
+import { Address, type DeepImmutable, Hex, parser, UnsignedDecimal, UnsignedInteger } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request frontend open orders.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info
+ */
+export const FrontendOpenOrdersRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("frontendOpenOrders"),
+        v.description("Type of request."),
+      ),
+      /** User address. */
+      user: v.pipe(
+        Address,
+        v.description("User address."),
+      ),
+      /** DEX name (empty string for main dex). */
+      dex: v.pipe(
+        v.optional(v.string()),
+        v.description("DEX name (empty string for main dex)."),
+      ),
+    }),
+    v.description("Request frontend open orders."),
+  );
+})();
+export type FrontendOpenOrdersRequest = v.InferOutput<typeof FrontendOpenOrdersRequest>;
+
+/**
+ * Array of open orders with additional display information.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info
+ */
+export const FrontendOpenOrdersResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.array(
+      /** Open order with additional display information. */
+      v.pipe(
+        v.object({
+          /** Asset symbol. */
+          coin: v.pipe(
+            v.string(),
+            v.description("Asset symbol."),
+          ),
+          /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
+          side: v.pipe(
+            v.union([v.literal("B"), v.literal("A")]),
+            v.description('Order side ("B" = Bid/Buy, "A" = Ask/Sell).'),
+          ),
+          /** Limit price. */
+          limitPx: v.pipe(
+            UnsignedDecimal,
+            v.description("Limit price."),
+          ),
+          /** Size. */
+          sz: v.pipe(
+            UnsignedDecimal,
+            v.description("Size."),
+          ),
+          /** Order ID. */
+          oid: v.pipe(
+            UnsignedInteger,
+            v.description("Order ID."),
+          ),
+          /** Timestamp when the order was placed (in ms since epoch). */
+          timestamp: v.pipe(
+            UnsignedInteger,
+            v.description("Timestamp when the order was placed (in ms since epoch)."),
+          ),
+          /** Original size at order placement. */
+          origSz: v.pipe(
+            UnsignedDecimal,
+            v.description("Original size at order placement."),
+          ),
+          /** Condition for triggering the order. */
+          triggerCondition: v.pipe(
+            v.string(),
+            v.description("Condition for triggering the order."),
+          ),
+          /** Indicates if the order is a trigger order. */
+          isTrigger: v.pipe(
+            v.boolean(),
+            v.description("Indicates if the order is a trigger order."),
+          ),
+          /** Trigger price. */
+          triggerPx: v.pipe(
+            UnsignedDecimal,
+            v.description("Trigger price."),
+          ),
+          /** Child orders associated with this order. */
+          children: v.pipe(
+            // deno-lint-ignore no-explicit-any
+            v.lazy<any>(() => FrontendOpenOrdersResponse),
+            v.description("Child orders associated with this order."),
+          ),
+          /** Indicates if the order is a position TP/SL order. */
+          isPositionTpsl: v.pipe(
+            v.boolean(),
+            v.description("Indicates if the order is a position TP/SL order."),
+          ),
+          /** Indicates whether the order is reduce-only. */
+          reduceOnly: v.pipe(
+            v.boolean(),
+            v.description("Indicates whether the order is reduce-only."),
+          ),
+          /**
+           * Order type for market execution.
+           * - `"Market"`: Executes immediately at the market price.
+           * - `"Limit"`: Executes at the specified limit price or better.
+           * - `"Stop Market"`: Activates as a market order when a stop price is reached.
+           * - `"Stop Limit"`: Activates as a limit order when a stop price is reached.
+           * - `"Take Profit Market"`: Executes as a market order when a take profit price is reached.
+           * - `"Take Profit Limit"`: Executes as a limit order when a take profit price is reached.
+           * @see https://hyperliquid.gitbook.io/hyperliquid-docs/trading/order-types
+           */
+          orderType: v.pipe(
+            v.union([
+              v.literal("Market"),
+              v.literal("Limit"),
+              v.literal("Stop Market"),
+              v.literal("Stop Limit"),
+              v.literal("Take Profit Market"),
+              v.literal("Take Profit Limit"),
+            ]),
+            v.description(
+              "Order type for market execution." +
+                '\n- `"Market"`: Executes immediately at the market price. ' +
+                '\n- `"Limit"`: Executes at the specified limit price or better. ' +
+                '\n- `"Stop Market"`: Activates as a market order when a stop price is reached. ' +
+                '\n- `"Stop Limit"`: Activates as a limit order when a stop price is reached. ' +
+                '\n- `"Take Profit Market"`: Executes as a market order when a take profit price is reached. ' +
+                '\n- `"Take Profit Limit"`: Executes as a limit order when a take profit price is reached. ',
+            ),
+          ),
+          /**
+           * Time-in-force options.
+           * - `"Gtc"`: Remains active until filled or canceled.
+           * - `"Ioc"`: Fills immediately or cancels any unfilled portion.
+           * - `"Alo"`: Adds liquidity only.
+           * - `"FrontendMarket"`: Similar to Ioc, used in Hyperliquid UI.
+           * - `"LiquidationMarket"`: Similar to Ioc, used in Hyperliquid UI.
+           */
+          tif: v.pipe(
+            v.union([
+              v.union([
+                v.literal("Gtc"),
+                v.literal("Ioc"),
+                v.literal("Alo"),
+                v.literal("FrontendMarket"),
+                v.literal("LiquidationMarket"),
+              ]),
+              v.null(),
+            ]),
+            v.description(
+              "Time-in-force options." +
+                '\n- `"Gtc"`: Remains active until filled or canceled. ' +
+                '\n- `"Ioc"`: Fills immediately or cancels any unfilled portion. ' +
+                '\n- `"Alo"`: Adds liquidity only. ' +
+                '\n- `"FrontendMarket"`: Similar to Ioc, used in Hyperliquid UI. ' +
+                '\n- `"LiquidationMarket"`: Similar to Ioc, used in Hyperliquid UI.',
+            ),
+          ),
+          /** Client Order ID. */
+          cloid: v.pipe(
+            v.union([v.pipe(Hex, v.length(34)), v.null()]),
+            v.description("Client Order ID."),
+          ),
+        }),
+        v.description("Open order with additional display information."),
+      ),
+    ),
+    v.description("Array of open orders with additional display information."),
+  );
+})();
+export type FrontendOpenOrdersResponse = v.InferOutput<typeof FrontendOpenOrdersResponse>;
+
+// -------------------- Function --------------------
+
+/** Request parameters for the {@linkcode frontendOpenOrders} function. */
+export type FrontendOpenOrdersParameters = Omit<v.InferInput<typeof FrontendOpenOrdersRequest>, "type">;
+
+/**
+ * Request frontend open orders.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of open orders with additional display information.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { frontendOpenOrders } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await frontendOpenOrders(
+ *   { transport },
+ *   { user: "0x..." },
+ * );
+ * ```
+ */
+export function frontendOpenOrders(
+  config: InfoRequestConfig,
+  params: DeepImmutable<FrontendOpenOrdersParameters>,
+  signal?: AbortSignal,
+): Promise<FrontendOpenOrdersResponse> {
+  const request = parser(FrontendOpenOrdersRequest)({
+    type: "frontendOpenOrders",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/src/api/info/fundingHistory.ts

@@ -0,0 +1,116 @@
+import * as v from "valibot";
+import { Decimal, type DeepImmutable, parser, UnsignedInteger } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request funding history.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates
+ */
+export const FundingHistoryRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("fundingHistory"),
+        v.description("Type of request."),
+      ),
+      /** Asset symbol (e.g., BTC). */
+      coin: v.pipe(
+        v.string(),
+        v.description("Asset symbol (e.g., BTC)."),
+      ),
+      /** Start time (in ms since epoch). */
+      startTime: v.pipe(
+        UnsignedInteger,
+        v.description("Start time (in ms since epoch)."),
+      ),
+      /** End time (in ms since epoch). */
+      endTime: v.pipe(
+        v.nullish(UnsignedInteger),
+        v.description("End time (in ms since epoch)."),
+      ),
+    }),
+    v.description("Request funding history."),
+  );
+})();
+export type FundingHistoryRequest = v.InferOutput<typeof FundingHistoryRequest>;
+
+/**
+ * Array of historical funding rate records for an asset.
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates
+ */
+export const FundingHistoryResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.array(
+      /** Historical funding rate record for an asset. */
+      v.pipe(
+        v.object({
+          /** Asset symbol. */
+          coin: v.pipe(
+            v.string(),
+            v.description("Asset symbol."),
+          ),
+          /** Funding rate. */
+          fundingRate: v.pipe(
+            Decimal,
+            v.description("Funding rate."),
+          ),
+          /** Premium price. */
+          premium: v.pipe(
+            Decimal,
+            v.description("Premium price."),
+          ),
+          /** Funding record timestamp (ms since epoch). */
+          time: v.pipe(
+            UnsignedInteger,
+            v.description("Funding record timestamp (ms since epoch)."),
+          ),
+        }),
+        v.description("Historical funding rate record for an asset."),
+      ),
+    ),
+    v.description("Array of historical funding rate records for an asset."),
+  );
+})();
+export type FundingHistoryResponse = v.InferOutput<typeof FundingHistoryResponse>;
+
+// -------------------- Function --------------------
+
+/** Request parameters for the {@linkcode fundingHistory} function. */
+export type FundingHistoryParameters = Omit<v.InferInput<typeof FundingHistoryRequest>, "type">;
+
+/**
+ * Request funding history.
+ * @param config - General configuration for Info API requests.
+ * @param params - Parameters specific to the API request.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of historical funding rate records for an asset.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-historical-funding-rates
+ * @example
+ * ```ts
+ * import { HttpTransport } from "@nktkas/hyperliquid";
+ * import { fundingHistory } from "@nktkas/hyperliquid/api/info";
+ *
+ * const transport = new HttpTransport(); // or `WebSocketTransport`
+ * const data = await fundingHistory(
+ *   { transport },
+ *   { coin: "ETH", startTime: Date.now() - 1000 * 60 * 60 * 24 },
+ * );
+ * ```
+ */
+export function fundingHistory(
+  config: InfoRequestConfig,
+  params: DeepImmutable<FundingHistoryParameters>,
+  signal?: AbortSignal,
+): Promise<FundingHistoryResponse> {
+  const request = parser(FundingHistoryRequest)({
+    type: "fundingHistory",
+    ...params,
+  });
+  return config.transport.request("info", request, signal);
+}

package/src/src/api/info/gossipRootIps.ts

@@ -0,0 +1,65 @@
+import * as v from "valibot";
+import { parser } from "../_common.js";
+import type { InfoRequestConfig } from "./_common.js";
+
+// -------------------- Schemas --------------------
+
+/**
+ * Request gossip root IPs.
+ * @see null
+ */
+export const GossipRootIpsRequest = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.object({
+      /** Type of request. */
+      type: v.pipe(
+        v.literal("gossipRootIps"),
+        v.description("Type of request."),
+      ),
+    }),
+    v.description("Request gossip root IPs."),
+  );
+})();
+export type GossipRootIpsRequest = v.InferOutput<typeof GossipRootIpsRequest>;
+
+/**
+ * Array of gossip root IPs.
+ * @see null
+ */
+export const GossipRootIpsResponse = /* @__PURE__ */ (() => {
+  return v.pipe(
+    v.array(v.pipe(v.string(), v.ipv4())),
+    v.description("Array of gossip root IPs."),
+  );
+})();
+export type GossipRootIpsResponse = v.InferOutput<typeof GossipRootIpsResponse>;
+
+// -------------------- Function --------------------
+
+/**
+ * Request gossip root IPs.
+ * @param config - General configuration for Info API requests.
+ * @param signal - An [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) can be used to cancel the request by calling [`abort()`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort) on the corresponding [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+ * @returns Array of gossip root IPs.
+ *
+ * @throws {TransportError} When the transport layer throws an error.
+ *
+ * @see null
+ * @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 function gossipRootIps(
+  config: InfoRequestConfig,
+  signal?: AbortSignal,
+): Promise<GossipRootIpsResponse> {
+  const request = parser(GossipRootIpsRequest)({
+    type: "gossipRootIps",
+  });
+  return config.transport.request("info", request, signal);
+}