@nktkas/hyperliquid/esm/src/api/info/_methods/preTransferCheck.js

Hyperliquid API SDK for all major JS runtimes, written in TypeScript.

import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { Address, UnsignedDecimal } from "../../_schemas.js";
/**
 * Request user existence check before transfer.
 */
export const PreTransferCheckRequest = /* @__PURE__ */ (() => {
    return v.pipe(v.object({
        /** Type of request. */
        type: v.pipe(v.literal("preTransferCheck"), v.description("Type of request.")),
        /** User address. */
        user: v.pipe(Address, v.description("User address.")),
        /** Source address. */
        source: v.pipe(Address, v.description("Source address.")),
    }), v.description("Request user existence check before transfer."));
})();
/**
 * Pre-transfer user existence check result.
 */
export const PreTransferCheckResponse = /* @__PURE__ */ (() => {
    return v.pipe(v.object({
        /** Activation fee. */
        fee: v.pipe(UnsignedDecimal, v.description("Activation fee.")),
        /** Whether the user is sanctioned. */
        isSanctioned: v.pipe(v.boolean(), v.description("Whether the user is sanctioned.")),
        /** Whether the user exists. */
        userExists: v.pipe(v.boolean(), v.description("Whether the user exists.")),
        /** Whether the user has sent a transaction. */
        userHasSentTx: v.pipe(v.boolean(), v.description("Whether the user has sent a transaction.")),
    }), v.description("Pre-transfer user existence check result."));
})();
/**
 * Request user existence check before transfer.
 *
 * @param config - General configuration for Info API requests.
 * @param params - Parameters specific to the API request.
 * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
 *
 * @returns Pre-transfer user existence check result.
 *
 * @throws {ValiError} When the request parameters fail validation (before sending).
 * @throws {TransportError} When the transport layer throws an error.
 *
 * @example
 * ```ts
 * import { HttpTransport } from "@nktkas/hyperliquid";
 * import { preTransferCheck } from "@nktkas/hyperliquid/api/info";
 *
 * const transport = new HttpTransport(); // or `WebSocketTransport`
 *
 * const data = await preTransferCheck(
 *   { transport },
 *   { user: "0x...", source: "0x..." },
 * );
 * ```
 */
export function preTransferCheck(config, params, signal) {
    const request = v.parse(PreTransferCheckRequest, {
        type: "preTransferCheck",
        ...params,
    });
    return config.transport.request("info", request, signal);
}
//# sourceMappingURL=preTransferCheck.js.map