@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
84 lines • 3.59 kB
JavaScript
import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { UnsignedInteger } from "../../_schemas.js";
import { ErrorResponse, Nonce, Signature, SuccessResponse } from "./_base/schemas.js";
/** Jail or unjail self as a validator signer. */
export const CSignerActionRequest = /* @__PURE__ */ (() => {
return v.pipe(v.object({
/** Action to perform. */
action: v.pipe(v.union([
v.object({
/** Type of action. */
type: v.pipe(v.literal("CSignerAction"), v.description("Type of action.")),
/** Jail the signer. */
jailSelf: v.pipe(v.null(), v.description("Jail the signer.")),
}),
v.object({
/** Type of action. */
type: v.pipe(v.literal("CSignerAction"), v.description("Type of action.")),
/** Unjail the signer. */
unjailSelf: v.pipe(v.null(), v.description("Unjail the signer.")),
}),
]), 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("Jail or unjail self as a validator signer."));
})();
/** Successful response without specific data or error response. */
export const CSignerActionResponse = /* @__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 CSignerActionParameters = /* @__PURE__ */ (() => {
return v.union(CSignerActionRequest.entries.action.options.map((option) => v.omit(option, ["type"])));
})();
/**
* Jail or unjail self as a validator signer.
*
* @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 { cSignerAction } from "@nktkas/hyperliquid/api/exchange";
* import { privateKeyToAccount } from "npm:viem/accounts";
*
* const wallet = privateKeyToAccount("0x..."); // viem or ethers
* const transport = new HttpTransport(); // or `WebSocketTransport`
*
* // Jail self
* await cSignerAction(
* { transport, wallet },
* { jailSelf: null },
* );
*
* // Unjail self
* await cSignerAction(
* { transport, wallet },
* { unjailSelf: null },
* );
* ```
*/
export function cSignerAction(config, params, opts) {
const action = v.parse(CSignerActionParameters, params);
return executeL1Action(config, { type: "CSignerAction", ...action }, opts);
}
//# sourceMappingURL=cSignerAction.js.map