@nktkas/hyperliquid/esm/api/info/_methods/gossipPriorityAuctionStatus.d.ts

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

/// <amd-module name="file:///home/runner/work/hyperliquid/hyperliquid/src/api/info/_methods/gossipPriorityAuctionStatus.ts" />
import * as v from "valibot";
import type { PerpDeployAuctionStatusResponse } from "./perpDeployAuctionStatus.js";
/**
 * Request gossip priority auction status (previous winners and current auctions).
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/priority-fees
 */
export declare const GossipPriorityAuctionStatusRequest: v.ObjectSchema<{
    /** Type of request. */
    readonly type: v.LiteralSchema<"gossipPriorityAuctionStatus", undefined>;
}, undefined>;
export type GossipPriorityAuctionStatusRequest = v.InferOutput<typeof GossipPriorityAuctionStatusRequest>;
/**
 * Gossip priority auction status.
 *
 * A two-element tuple:
 * - `[0]`: previous auction winner IPs per slot (or `null` if no previous winner).
 * - `[1]`: current auction statuses per slot (same shape as {@linkcode PerpDeployAuctionStatusResponse}).
 *
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/priority-fees
 */
export type GossipPriorityAuctionStatusResponse = [
    /** Previous auction winner IPs per slot, or `null` if no previous winner. */
    (`${number}.${number}.${number}.${number}` | null)[],
    /** Current auction statuses per slot. */
    PerpDeployAuctionStatusResponse[]
];
import type { InfoConfig } from "./_base/mod.js";
/**
 * Request gossip priority auction status (previous winners and current auctions).
 *
 * @param config General configuration for Info API requests.
 * @param signal {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal} to cancel the request.
 * @return Gossip priority auction status.
 *
 * @throws {ValidationError} 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 { gossipPriorityAuctionStatus } from "@nktkas/hyperliquid/api/info";
 *
 * const transport = new HttpTransport(); // or `WebSocketTransport`
 *
 * const data = await gossipPriorityAuctionStatus({ transport });
 * ```
 *
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/priority-fees
 */
export declare function gossipPriorityAuctionStatus(config: InfoConfig, signal?: AbortSignal): Promise<GossipPriorityAuctionStatusResponse>;