@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
76 lines • 3.46 kB
JavaScript
import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { Address, UnsignedInteger } from "../../_schemas.js";
import { ErrorResponse, Nonce, Signature, SuccessResponse } from "./_base/schemas.js";
/** Distribute funds from a vault between followers. */
export const VaultDistributeRequest = /* @__PURE__ */ (() => {
return v.pipe(v.object({
/** Action to perform. */
action: v.pipe(v.object({
/** Type of action. */
type: v.pipe(v.literal("vaultDistribute"), v.description("Type of action.")),
/** Vault address. */
vaultAddress: v.pipe(Address, v.description("Vault address.")),
/**
* Amount to distribute (float * 1e6).
*
* Set to 0 to close the vault.
*/
usd: v.pipe(UnsignedInteger, v.description("Amount to distribute (float * 1e6)." +
"\n\nSet to 0 to close the vault.")),
}), 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("Distribute funds from a vault between followers."));
})();
/** Successful response without specific data or error response. */
export const VaultDistributeResponse = /* @__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 VaultDistributeParameters = /* @__PURE__ */ (() => {
return v.omit(v.object(VaultDistributeRequest.entries.action.entries), ["type"]);
})();
/**
* Distribute funds from a vault between followers.
*
* @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 { vaultDistribute } 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 vaultDistribute(
* { transport, wallet },
* { vaultAddress: "0x...", usd: 10 * 1e6 },
* );
* ```
*/
export function vaultDistribute(config, params, opts) {
const action = v.parse(VaultDistributeParameters, params);
return executeL1Action(config, { type: "vaultDistribute", ...action }, opts);
}
//# sourceMappingURL=vaultDistribute.js.map