@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
56 lines • 2.32 kB
JavaScript
import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { SpotAssetCtxSchema } from "./_base/commonSchemas.js";
import { SpotMetaResponse } from "./spotMeta.js";
/**
* Request spot metadata and asset contexts.
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
*/
export const SpotMetaAndAssetCtxsRequest = /* @__PURE__ */ (() => {
return v.pipe(v.object({
/** Type of request. */
type: v.pipe(v.literal("spotMetaAndAssetCtxs"), v.description("Type of request.")),
}), v.description("Request spot metadata and asset contexts."));
})();
/**
* Tuple of spot metadata and asset contexts.
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
*/
export const SpotMetaAndAssetCtxsResponse = /* @__PURE__ */ (() => {
return v.pipe(v.tuple([
SpotMetaResponse,
v.array(SpotAssetCtxSchema),
]), v.description("Tuple of spot metadata and asset contexts."));
})();
/**
* Request spot metadata and asset contexts.
*
* @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 Metadata and context for spot assets.
*
* @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 { spotMetaAndAssetCtxs } from "@nktkas/hyperliquid/api/info";
*
* const transport = new HttpTransport(); // or `WebSocketTransport`
*
* const data = await spotMetaAndAssetCtxs({ transport });
* ```
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-spot-asset-contexts
*/
export function spotMetaAndAssetCtxs(config, signal) {
const request = v.parse(SpotMetaAndAssetCtxsRequest, {
type: "spotMetaAndAssetCtxs",
});
return config.transport.request("info", request, signal);
}
//# sourceMappingURL=spotMetaAndAssetCtxs.js.map