@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
232 lines • 11.8 kB
JavaScript
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.OrderResponse = exports.OrderRequest = void 0;
exports.order = order;
const v = __importStar(require("valibot"));
// ============================================================
// API Schemas
// ============================================================
const _schemas_js_1 = require("../../_schemas.js");
const schemas_js_1 = require("./_base/schemas.js");
/**
* Place an order(s).
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order
*/
exports.OrderRequest = (() => {
return v.pipe(v.object({
/** Action to perform. */
action: v.pipe(v.object({
/** Type of action. */
type: v.pipe(v.literal("order"), v.description("Type of action.")),
/** Array of order parameters. */
orders: v.pipe(v.array(v.pipe(v.object({
/** Asset ID. */
a: v.pipe(_schemas_js_1.UnsignedInteger, v.description("Asset ID.")),
/** Position side (`true` for long, `false` for short). */
b: v.pipe(v.boolean(), v.description("Position side (`true` for long, `false` for short).")),
/** Price. */
p: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Price.")),
/** Size (in base currency units). */
s: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Size (in base currency units).")),
/** Is reduce-only? */
r: v.pipe(v.boolean(), v.description("Is reduce-only?")),
/** Order type. */
t: v.pipe(v.union([
v.object({
/** Limit order parameters. */
limit: v.pipe(v.object({
/**
* Time-in-force.
* - `"Gtc"`: Remains active until filled or canceled.
* - `"Ioc"`: Fills immediately or cancels any unfilled portion.
* - `"Alo"`: Adds liquidity only.
* - `"FrontendMarket"`: Similar to Ioc, used in Hyperliquid UI.
* - `"LiquidationMarket"`: Similar to Ioc, used in Hyperliquid UI.
*/
tif: v.pipe(v.picklist(["Gtc", "Ioc", "Alo", "FrontendMarket", "LiquidationMarket"]), v.description("Time-in-force." +
'\n- `"Gtc"`: Remains active until filled or canceled.' +
'\n- `"Ioc"`: Fills immediately or cancels any unfilled portion.' +
'\n- `"Alo"`: Adds liquidity only.' +
'\n- `"FrontendMarket"`: Similar to Ioc, used in Hyperliquid UI.' +
'\n- `"LiquidationMarket"`: Similar to Ioc, used in Hyperliquid UI.')),
}), v.description("Limit order parameters.")),
}),
v.object({
/** Trigger order parameters. */
trigger: v.pipe(v.object({
/** Is market order? */
isMarket: v.pipe(v.boolean(), v.description("Is market order?")),
/** Trigger price. */
triggerPx: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Trigger price.")),
/** Indicates whether it is take profit or stop loss. */
tpsl: v.pipe(v.picklist(["tp", "sl"]), v.description("Indicates whether it is take profit or stop loss.")),
}), v.description("Trigger order parameters.")),
}),
]), v.description("Order type.")),
/** Client Order ID. */
c: v.pipe(v.optional(v.pipe(_schemas_js_1.Hex, v.length(34))), v.description("Client Order ID.")),
}), v.description("Place order parameters."))), v.description("Array of order parameters.")),
/**
* Order grouping strategy:
* - `na`: Standard order without grouping (default).
* - `normalTpsl`: TP/SL order with fixed size that doesn't adjust with position changes.
* - `positionTpsl`: TP/SL order that adjusts proportionally with the position size.
*/
grouping: v.pipe(v.optional(v.picklist(["na", "normalTpsl", "positionTpsl"]), "na"), v.description("Order grouping strategy:" +
"\n- `na`: Standard order without grouping." +
"\n- `normalTpsl`: TP/SL order with fixed size that doesn't adjust with position changes." +
"\n- `positionTpsl`: TP/SL order that adjusts proportionally with the position size.")),
/** Builder fee. */
builder: v.pipe(v.optional(v.object({
/** Builder address. */
b: v.pipe(_schemas_js_1.Address, v.description("Builder address.")),
/** Builder fee in 0.1bps (1 = 0.0001%). */
f: v.pipe(_schemas_js_1.UnsignedInteger, v.description("Builder fee in 0.1bps (1 = 0.0001%).")),
})), v.description("Builder fee.")),
}), v.description("Action to perform.")),
/** Nonce (timestamp in ms) used to prevent replay attacks. */
nonce: schemas_js_1.Nonce,
/** ECDSA signature components. */
signature: schemas_js_1.Signature,
/** Vault address (for vault trading). */
vaultAddress: v.pipe(v.optional(_schemas_js_1.Address), v.description("Vault address (for vault trading).")),
/** Expiration time of the action. */
expiresAfter: v.pipe(v.optional(_schemas_js_1.UnsignedInteger), v.description("Expiration time of the action.")),
}), v.description("Place an order(s)."));
})();
/**
* Response for order placement.
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order
*/
exports.OrderResponse = (() => {
return v.pipe(v.object({
/** Successful status. */
status: v.pipe(v.literal("ok"), v.description("Successful status.")),
/** Response details. */
response: v.pipe(v.object({
/** Type of response. */
type: v.pipe(v.literal("order"), v.description("Type of response.")),
/** Specific data. */
data: v.pipe(v.object({
/** Array of statuses or error messages. */
statuses: v.pipe(v.array(v.union([
v.object({
/** Resting order status. */
resting: v.pipe(v.object({
/** Order ID. */
oid: v.pipe(_schemas_js_1.UnsignedInteger, v.description("Order ID.")),
/** Client Order ID. */
cloid: v.pipe(v.optional(v.pipe(_schemas_js_1.Hex, v.length(34))), v.description("Client Order ID.")),
}), v.description("Resting order status.")),
}),
v.object({
/** Filled order status. */
filled: v.pipe(v.object({
/** Total size filled. */
totalSz: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Total size filled.")),
/** Average price of fill. */
avgPx: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Average price of fill.")),
/** Order ID. */
oid: v.pipe(_schemas_js_1.UnsignedInteger, v.description("Order ID.")),
/** Client Order ID. */
cloid: v.pipe(v.optional(v.pipe(_schemas_js_1.Hex, v.length(34))), v.description("Client Order ID.")),
}), v.description("Filled order status.")),
}),
v.object({
/** Error message. */
error: v.pipe(v.string(), v.description("Error message.")),
}),
])), v.description("Array of statuses or error messages.")),
}), v.description("Specific data.")),
}), v.description("Response details.")),
}), v.description("Response for order placement."));
})();
// ============================================================
// Execution Logic
// ============================================================
const execute_js_1 = require("./_base/execute.js");
/** Schema for user-provided action parameters (excludes system fields). */
const OrderParameters = /* @__PURE__ */ (() => {
return v.omit(v.object(exports.OrderRequest.entries.action.entries), ["type"]);
})();
/**
* Place an order(s).
*
* @param config - General configuration for Exchange API requests.
* @param params - Parameters specific to the API request.
* @param opts - Request execution options.
*
* @returns Successful variant of {@link OrderResponse} without error statuses.
*
* @throws {ValiError} When the request parameters fail validation (before sending).
* @throws {TransportError} When the transport layer throws an error.
* @throws {ApiRequestError} When the API returns an unsuccessful response.
*
* @example
* ```ts
* import { HttpTransport } from "@nktkas/hyperliquid";
* import { order } from "@nktkas/hyperliquid/api/exchange";
* import { privateKeyToAccount } from "npm:viem/accounts";
*
* const wallet = privateKeyToAccount("0x..."); // viem or ethers
* const transport = new HttpTransport(); // or `WebSocketTransport`
*
* const data = await order(
* { transport, wallet },
* {
* orders: [
* {
* a: 0,
* b: true,
* p: "30000",
* s: "0.1",
* r: false,
* t: { limit: { tif: "Gtc" } },
* c: "0x...",
* },
* ],
* grouping: "na",
* },
* );
* ```
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order
*/
function order(config, params, opts) {
const action = v.parse(OrderParameters, params);
return (0, execute_js_1.executeL1Action)(config, { type: "order", ...action }, opts);
}
//# sourceMappingURL=order.js.map