@nktkas/hyperliquid/esm/api/info/_methods/perpDeployAuctionStatus.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/perpDeployAuctionStatus.ts" />
import * as v from "valibot";
/**
 * Request for the status of the perpetual deploy auction.
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
 */
export declare const PerpDeployAuctionStatusRequest: v.ObjectSchema<{
    /** Type of request. */
    readonly type: v.LiteralSchema<"perpDeployAuctionStatus", undefined>;
}, undefined>;
export type PerpDeployAuctionStatusRequest = v.InferOutput<typeof PerpDeployAuctionStatusRequest>;
/**
 * Status of the perpetual deploy auction.
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
 */
export type PerpDeployAuctionStatusResponse = {
    /**
     * Current gas.
     * @pattern ^[0-9]+(\.[0-9]+)?$
     */
    currentGas: string | null;
    /** Duration in seconds. */
    durationSeconds: number;
    /**
     * Ending gas.
     * @pattern ^[0-9]+(\.[0-9]+)?$
     */
    endGas: string | null;
    /**
     * Starting gas.
     * @pattern ^[0-9]+(\.[0-9]+)?$
     */
    startGas: string;
    /** Auction start time (in seconds since epoch). */
    startTimeSeconds: number;
};
import type { InfoConfig } from "./_base/mod.js";
/**
 * Request for the status of the perpetual deploy auction.
 *
 * @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 Status of the perpetual deploy auction.
 *
 * @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 { perpDeployAuctionStatus } from "@nktkas/hyperliquid/api/info";
 *
 * const transport = new HttpTransport(); // or `WebSocketTransport`
 *
 * const data = await perpDeployAuctionStatus({ transport });
 * ```
 *
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction
 */
export declare function perpDeployAuctionStatus(config: InfoConfig, signal?: AbortSignal): Promise<PerpDeployAuctionStatusResponse>;