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

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

import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { Address, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
import { VaultRelationshipSchema } from "./_base/commonSchemas.js";
/**
 * Request a list of vaults less than 2 hours old.
 */
export const VaultSummariesRequest = /* @__PURE__ */ (() => {
    return v.pipe(v.object({
        /** Type of request. */
        type: v.pipe(v.literal("vaultSummaries"), v.description("Type of request.")),
    }), v.description("Request a list of vaults less than 2 hours old."));
})();
/**
 * Array of vaults less than 2 hours old.
 */
export const VaultSummariesResponse = /* @__PURE__ */ (() => {
    return v.pipe(v.array(v.object({
        /** Vault name. */
        name: v.pipe(v.string(), v.description("Vault name.")),
        /** Vault address. */
        vaultAddress: v.pipe(Address, v.description("Vault address.")),
        /** Leader address. */
        leader: v.pipe(Address, v.description("Leader address.")),
        /** Total value locked. */
        tvl: v.pipe(UnsignedDecimal, v.description("Total value locked.")),
        /** Vault closure status. */
        isClosed: v.pipe(v.boolean(), v.description("Vault closure status.")),
        /** Vault relationship type. */
        relationship: v.pipe(VaultRelationshipSchema, v.description("Vault relationship type.")),
        /** Creation timestamp. */
        createTimeMillis: v.pipe(UnsignedInteger, v.description("Creation timestamp.")),
    })), v.description("Array of vaults less than 2 hours old."));
})();
/**
 * Request a list of vaults less than 2 hours old.
 *
 * @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.
 *
 * @returns Array of vaults less than 2 hours old.
 *
 * @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 { vaultSummaries } from "@nktkas/hyperliquid/api/info";
 *
 * const transport = new HttpTransport(); // or `WebSocketTransport`
 *
 * const data = await vaultSummaries({ transport });
 * ```
 */
export function vaultSummaries(config, signal) {
    const request = v.parse(VaultSummariesRequest, {
        type: "vaultSummaries",
    });
    return config.transport.request("info", request, signal);
}
//# sourceMappingURL=vaultSummaries.js.map