@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
141 lines • 6.94 kB
JavaScript
import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { Address, Hex, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
import { ErrorResponse, Nonce, Signature, SuccessResponse } from "./_base/schemas.js";
/**
* Modify an order.
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-an-order
*/
export const ModifyRequest = /* @__PURE__ */ (() => {
return v.pipe(v.object({
/** Action to perform. */
action: v.pipe(v.object({
/** Type of action. */
type: v.pipe(v.literal("modify"), v.description("Type of action.")),
/** Order ID or Client Order ID. */
oid: v.pipe(v.union([
UnsignedInteger,
v.pipe(Hex, v.length(34)),
]), v.description("Order ID or Client Order ID.")),
/** New order parameters. */
order: v.pipe(v.object({
/** Asset ID. */
a: v.pipe(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(UnsignedDecimal, v.description("Price.")),
/** Size (in base currency units). */
s: v.pipe(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(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(Hex, v.length(34))), v.description("Client Order ID.")),
}), v.description("New order parameters.")),
}), v.description("Action to perform.")),
/** Nonce (timestamp in ms) used to prevent replay attacks. */
nonce: Nonce,
/** ECDSA signature components. */
signature: Signature,
/** Vault address (for vault trading). */
vaultAddress: v.pipe(v.optional(Address), v.description("Vault address (for vault trading).")),
/** Expiration time of the action. */
expiresAfter: v.pipe(v.optional(UnsignedInteger), v.description("Expiration time of the action.")),
}), v.description("Modify an order."));
})();
/**
* Successful response without specific data or error response.
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-an-order
*/
export const ModifyResponse = /* @__PURE__ */ (() => {
return v.pipe(v.union([SuccessResponse, ErrorResponse]), v.description("Successful response without specific data or error response."));
})();
// ============================================================
// Execution Logic
// ============================================================
import { executeL1Action } from "./_base/execute.js";
/** Schema for user-provided action parameters (excludes system fields). */
const ModifyParameters = /* @__PURE__ */ (() => {
return v.omit(v.object(ModifyRequest.entries.action.entries), ["type"]);
})();
/**
* Modify an order.
*
* @param config - General configuration for Exchange API requests.
* @param params - Parameters specific to the API request.
* @param opts - Request execution options.
*
* @returns Successful response without specific data.
*
* @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 { modify } from "@nktkas/hyperliquid/api/exchange";
* import { privateKeyToAccount } from "npm:viem/accounts";
*
* const wallet = privateKeyToAccount("0x..."); // viem or ethers
* const transport = new HttpTransport(); // or `WebSocketTransport`
*
* await modify(
* { transport, wallet },
* {
* oid: 123,
* order: {
* a: 0,
* b: true,
* p: "31000",
* s: "0.2",
* r: false,
* t: { limit: { tif: "Gtc" } },
* c: "0x...",
* },
* },
* );
* ```
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#modify-an-order
*/
export function modify(config, params, opts) {
const action = v.parse(ModifyParameters, params);
return executeL1Action(config, { type: "modify", ...action }, opts);
}
//# sourceMappingURL=modify.js.map