@nktkas/hyperliquid/esm/api/subscription/_methods/outcomeMetaUpdates.d.ts

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

/// <amd-module name="file:///home/runner/work/hyperliquid/hyperliquid/src/api/subscription/_methods/outcomeMetaUpdates.ts" />
import * as v from "valibot";
/**
 * Subscription to prediction market outcome metadata updates.
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
 */
export declare const OutcomeMetaUpdatesRequest: v.ObjectSchema<{
    /** Type of subscription. */
    readonly type: v.LiteralSchema<"outcomeMetaUpdates", undefined>;
}, undefined>;
export type OutcomeMetaUpdatesRequest = v.InferOutput<typeof OutcomeMetaUpdatesRequest>;
/**
 * Event of prediction market outcome/question metadata updates.
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
 */
export type OutcomeMetaUpdatesEvent = {
    /** Array of metadata update events. */
    updates: ({
        /** Outcome created event. */
        outcomeCreated: {
            /** Outcome identifier. */
            outcome: number;
            /** Name of the outcome. */
            name: string;
            /** Description of the outcome. */
            description: string;
            /** Array of side specifications for this outcome. */
            sideSpecs: {
                /** Name of the side. */
                name: string;
                /** Token identifier for this side. */
                token?: number;
            }[];
            /** Quote token for this outcome. */
            quoteToken: string;
        };
    } | {
        /** Outcome settled event. */
        outcomeSettled: {
            /** Outcome identifier. */
            outcome: number;
        };
    } | {
        /** Question updated event. */
        questionUpdated: {
            /** Question identifier. */
            question: number;
            /** Name of the question. */
            name: string;
            /** Description of the question. */
            description: string;
            /** Fallback outcome identifier. */
            fallbackOutcome: number;
            /** Array of named outcome identifiers. */
            namedOutcomes: number[];
            /** Array of settled named outcome identifiers. */
            settledNamedOutcomes: number[];
        };
    } | {
        /** Question settled event. */
        questionSettled: {
            /** Question identifier. */
            question: number;
        };
    })[];
};
import type { ISubscription } from "../../../transport/mod.js";
import type { SubscriptionConfig, SubscriptionOptions } from "./_base/mod.js";
/**
 * Subscribe to prediction market outcome/question metadata updates.
 *
 * @param config General configuration for Subscription API subscriptions.
 * @param listener A callback function to be called when the event is received.
 * @param options Options to control the subscription lifecycle.
 * @return A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
 *
 * @throws {ValidationError} When the request parameters fail validation (before sending).
 * @throws {TransportError} When the transport layer throws an error.
 *
 * @example
 * ```ts
 * import { WebSocketTransport } from "@nktkas/hyperliquid";
 * import { outcomeMetaUpdates } from "@nktkas/hyperliquid/api/subscription";
 *
 * const transport = new WebSocketTransport();
 *
 * const sub = await outcomeMetaUpdates(
 *   { transport },
 *   (data) => console.log(data),
 * );
 * ```
 *
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
 */
export declare function outcomeMetaUpdates(config: SubscriptionConfig, listener: (data: OutcomeMetaUpdatesEvent) => void, options?: SubscriptionOptions): Promise<ISubscription>;