@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
71 lines • 3.27 kB
JavaScript
import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { Address, UnsignedInteger } from "../../_schemas.js";
import { ErrorResponse, Nonce, Signature, SuccessResponse } from "./_base/schemas.js";
/** Modify a sub-account's. */
export const SubAccountModifyRequest = /* @__PURE__ */ (() => {
return v.pipe(v.object({
/** Action to perform. */
action: v.pipe(v.object({
/** Type of action. */
type: v.pipe(v.literal("subAccountModify"), v.description("Type of action.")),
/** Sub-account address to modify. */
subAccountUser: v.pipe(Address, v.description("Sub-account address to modify.")),
/** New sub-account name. */
name: v.pipe(v.string(), v.minLength(1), v.description("New sub-account name.")),
}), v.description("Action to perform.")),
/** Nonce (timestamp in ms) used to prevent replay attacks. */
nonce: Nonce,
/** ECDSA signature components. */
signature: Signature,
/** Expiration time of the action. */
expiresAfter: v.pipe(v.optional(UnsignedInteger), v.description("Expiration time of the action.")),
}), v.description("Modify a sub-account."));
})();
/** Successful response without specific data or error response. */
export const SubAccountModifyResponse = /* @__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 SubAccountModifyParameters = /* @__PURE__ */ (() => {
return v.omit(v.object(SubAccountModifyRequest.entries.action.entries), ["type"]);
})();
/**
* Modify a sub-account's.
*
* @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 { subAccountModify } 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 subAccountModify(
* { transport, wallet },
* { subAccountUser: "0x...", name: "..." },
* );
* ```
*/
export function subAccountModify(config, params, opts) {
const action = v.parse(SubAccountModifyParameters, params);
return executeL1Action(config, { type: "subAccountModify", ...action }, opts);
}
//# sourceMappingURL=subAccountModify.js.map