@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
50 lines • 1.98 kB
JavaScript
import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { UnsignedDecimal } from "../../_schemas.js";
/**
* Request maximum market order notionals.
*/
export const MaxMarketOrderNtlsRequest = /* @__PURE__ */ (() => {
return v.pipe(v.object({
/** Type of request. */
type: v.pipe(v.literal("maxMarketOrderNtls"), v.description("Type of request.")),
}), v.description("Request maximum market order notionals."));
})();
/**
* Maximum market order notionals.
*/
export const MaxMarketOrderNtlsResponse = /* @__PURE__ */ (() => {
return v.pipe(v.array(
/** Tuple of maximum market order notional and corresponding asset symbol. */
v.pipe(v.tuple([UnsignedDecimal, v.string()]), v.description("Tuple of maximum market order notional and corresponding asset symbol."))), v.description("Maximum market order notionals."));
})();
/**
* Request maximum market order notionals.
*
* @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 Maximum market order notionals.
*
* @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 { maxMarketOrderNtls } from "@nktkas/hyperliquid/api/info";
*
* const transport = new HttpTransport(); // or `WebSocketTransport`
*
* const data = await maxMarketOrderNtls({ transport });
* ```
*/
export function maxMarketOrderNtls(config, signal) {
const request = v.parse(MaxMarketOrderNtlsRequest, {
type: "maxMarketOrderNtls",
});
return config.transport.request("info", request, signal);
}
//# sourceMappingURL=maxMarketOrderNtls.js.map