@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
94 lines • 4.05 kB
JavaScript
import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { Address, UnsignedInteger } from "../../_schemas.js";
import { ErrorResponse, Nonce, Signature } from "./_base/schemas.js";
/** Create a vault. */
export const CreateVaultRequest = /* @__PURE__ */ (() => {
return v.pipe(v.object({
/** Action to perform. */
action: v.pipe(v.object({
/** Type of action. */
type: v.pipe(v.literal("createVault"), v.description("Type of action.")),
/** Vault name. */
name: v.pipe(v.string(), v.minLength(3), v.description("Vault name.")),
/** Vault description. */
description: v.pipe(v.string(), v.minLength(10), v.description("Vault description.")),
/** Initial balance (float * 1e6). */
initialUsd: v.pipe(UnsignedInteger, v.minValue(100000000), // 100 USDC
v.description("Initial balance (float * 1e6).")),
/** Nonce (timestamp in ms) used to prevent replay attacks. */
nonce: Nonce,
}), 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("Create a vault."));
})();
/** Response for creating a vault. */
export const CreateVaultResponse = /* @__PURE__ */ (() => {
return v.pipe(v.union([
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("createVault"), v.description("Type of response.")),
/** Vault address. */
data: v.pipe(Address, v.description("Vault address.")),
}), v.description("Response details.")),
}), v.description("Successful response for creating a vault")),
ErrorResponse,
]), v.description("Response for creating a vault."));
})();
// ============================================================
// Execution Logic
// ============================================================
import { executeL1Action } from "./_base/execute.js";
/** Schema for user-provided action parameters (excludes system fields). */
const CreateVaultParameters = /* @__PURE__ */ (() => {
return v.omit(v.object(CreateVaultRequest.entries.action.entries), ["type"]);
})();
/**
* Create a vault.
*
* @param config - General configuration for Exchange API requests.
* @param params - Parameters specific to the API request.
* @param opts - Request execution options.
*
* @returns Response for creating a vault.
*
* @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 { createVault } 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 createVault(
* { transport, wallet },
* {
* name: "...",
* description: "...",
* initialUsd: 100 * 1e6,
* nonce: Date.now(),
* },
* );
* ```
*/
export function createVault(config, params, opts) {
const action = v.parse(CreateVaultParameters, params);
return executeL1Action(config, { type: "createVault", ...action }, opts);
}
//# sourceMappingURL=createVault.js.map