@nktkas/hyperliquid/esm/src/api/info/_methods/perpDexs.js

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

import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { Address, ISO8601WithoutTimezone, UnsignedDecimal } from "../../_schemas.js";
/**
 * Request all perpetual dexs.
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
 */
export const PerpDexsRequest = /* @__PURE__ */ (() => {
    return v.pipe(v.object({
        /** Type of request. */
        type: v.pipe(v.literal("perpDexs"), v.description("Type of request.")),
    }), v.description("Request all perpetual dexs."));
})();
/**
 * Array of perpetual dexes (null is main dex).
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
 */
export const PerpDexsResponse = /* @__PURE__ */ (() => {
    return v.pipe(v.array(v.nullable(
    /** Perpetual dex metadata. */
    v.pipe(v.object({
        /** Short name of the perpetual dex. */
        name: v.pipe(v.string(), v.description("Short name of the perpetual dex.")),
        /** Complete name of the perpetual dex. */
        fullName: v.pipe(v.string(), v.description("Complete name of the perpetual dex.")),
        /** Hex address of the dex deployer. */
        deployer: v.pipe(Address, v.description("Hex address of the dex deployer.")),
        /** Hex address of the oracle updater, or null if not available. */
        oracleUpdater: v.pipe(v.nullable(Address), v.description("Hex address of the oracle updater, or null if not available.")),
        /** Hex address of the fee recipient, or null if not available. */
        feeRecipient: v.pipe(v.nullable(Address), v.description("Hex address of the fee recipient, or null if not available.")),
        /** Mapping of asset names to their streaming open interest caps. */
        assetToStreamingOiCap: v.pipe(v.array(v.tuple([v.string(), v.string()])), v.description("Mapping of asset names to their streaming open interest caps.")),
        /** List of delegated function names and their authorized executor addresses. */
        subDeployers: v.pipe(v.array(v.tuple([
            v.string(),
            v.array(Address),
        ])), v.description("List of delegated function names and their authorized executor addresses.")),
        /** Fee scale applied to deployer fees. */
        deployerFeeScale: v.pipe(UnsignedDecimal, v.description("Fee scale applied to deployer fees.")),
        /** ISO 8601 timestamp (without timezone) of the last deployer fee scale change. */
        lastDeployerFeeScaleChangeTime: v.pipe(ISO8601WithoutTimezone, v.description("ISO 8601 timestamp (without timezone) of the last deployer fee scale change.")),
        /** Array of tuples mapping asset names to their funding multipliers. */
        assetToFundingMultiplier: v.pipe(v.array(v.tuple([v.string(), v.string()])), v.description("Array of tuples mapping asset names to their funding multipliers.")),
    }), v.description(" Perpetual dex metadata.")))), v.description("Array of perpetual dexes (null is main dex)."));
})();
/**
 * Request all perpetual dexs.
 *
 * @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 perpetual dexes (null is main dex).
 *
 * @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 { perpDexs } from "@nktkas/hyperliquid/api/info";
 *
 * const transport = new HttpTransport(); // or `WebSocketTransport`
 *
 * const data = await perpDexs({ transport });
 * ```
 *
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
 */
export function perpDexs(config, signal) {
    const request = v.parse(PerpDexsRequest, {
        type: "perpDexs",
    });
    return config.transport.request("info", request, signal);
}
//# sourceMappingURL=perpDexs.js.map