@nktkas/hyperliquid/script/src/api/info/_methods/userRole.d.ts

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

import * as v from "valibot";
/**
 * Request user role.
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
 */
export declare const UserRoleRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
    /** Type of request. */
    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"userRole", undefined>, v.DescriptionAction<"userRole", "Type of request.">]>;
    /** User address. */
    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
}, undefined>, v.DescriptionAction<{
    type: "userRole";
    user: `0x${string}`;
}, "Request user role.">]>;
export type UserRoleRequest = v.InferOutput<typeof UserRoleRequest>;
/**
 * User role.
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
 */
export declare const UserRoleResponse: v.SchemaWithPipe<readonly [v.VariantSchema<"role", [v.ObjectSchema<{
    /** Role identifier. */
    readonly role: v.SchemaWithPipe<readonly [v.PicklistSchema<["missing", "user", "vault"], undefined>, v.DescriptionAction<"user" | "vault" | "missing", "Role identifier.">]>;
}, undefined>, v.ObjectSchema<{
    /** Role identifier. */
    readonly role: v.SchemaWithPipe<readonly [v.LiteralSchema<"agent", undefined>, v.DescriptionAction<"agent", "Role identifier.">]>;
    /** Details for agent role. */
    readonly data: v.SchemaWithPipe<readonly [v.ObjectSchema<{
        /** Master account address associated with the agent. */
        readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "Master account address associated with the agent.">]>;
    }, undefined>, v.DescriptionAction<{
        user: `0x${string}`;
    }, "Details for agent role.">]>;
}, undefined>, v.ObjectSchema<{
    /** Role identifier. */
    readonly role: v.SchemaWithPipe<readonly [v.LiteralSchema<"subAccount", undefined>, v.DescriptionAction<"subAccount", "Role identifier.">]>;
    /** Details for sub-account role. */
    readonly data: v.SchemaWithPipe<readonly [v.ObjectSchema<{
        /** Master account address associated with the sub-account. */
        readonly master: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "Master account address associated with the sub-account.">]>;
    }, undefined>, v.DescriptionAction<{
        master: `0x${string}`;
    }, "Details for sub-account role.">]>;
}, undefined>], undefined>, v.DescriptionAction<{
    role: "user" | "vault" | "missing";
} | {
    role: "agent";
    data: {
        user: `0x${string}`;
    };
} | {
    role: "subAccount";
    data: {
        master: `0x${string}`;
    };
}, "User role.">]>;
export type UserRoleResponse = v.InferOutput<typeof UserRoleResponse>;
import type { InfoConfig } from "./_types.js";
/** Request parameters for the {@linkcode userRole} function. */
export type UserRoleParameters = Omit<v.InferInput<typeof UserRoleRequest>, "type">;
/**
 * Request user role.
 *
 * @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 User role.
 *
 * @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 { userRole } from "@nktkas/hyperliquid/api/info";
 *
 * const transport = new HttpTransport(); // or `WebSocketTransport`
 *
 * const data = await userRole(
 *   { transport },
 *   { user: "0x..." },
 * );
 * ```
 *
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
 */
export declare function userRole(config: InfoConfig, params: UserRoleParameters, signal?: AbortSignal): Promise<UserRoleResponse>;
//# sourceMappingURL=userRole.d.ts.map