@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
119 lines • 4.77 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.UserRoleResponse = exports.UserRoleRequest = void 0;
exports.userRole = userRole;
const v = __importStar(require("valibot"));
// ============================================================
// API Schemas
// ============================================================
const _schemas_js_1 = require("../../_schemas.js");
/**
* Request user role.
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
*/
exports.UserRoleRequest = (() => {
return v.pipe(v.object({
/** Type of request. */
type: v.pipe(v.literal("userRole"), v.description("Type of request.")),
/** User address. */
user: v.pipe(_schemas_js_1.Address, v.description("User address.")),
}), v.description("Request user role."));
})();
/**
* User role.
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-a-users-role
*/
exports.UserRoleResponse = (() => {
return v.pipe(v.variant("role", [
v.object({
/** Role identifier. */
role: v.pipe(v.picklist(["missing", "user", "vault"]), v.description("Role identifier.")),
}),
v.object({
/** Role identifier. */
role: v.pipe(v.literal("agent"), v.description("Role identifier.")),
/** Details for agent role. */
data: v.pipe(v.object({
/** Master account address associated with the agent. */
user: v.pipe(_schemas_js_1.Address, v.description("Master account address associated with the agent.")),
}), v.description("Details for agent role.")),
}),
v.object({
/** Role identifier. */
role: v.pipe(v.literal("subAccount"), v.description("Role identifier.")),
/** Details for sub-account role. */
data: v.pipe(v.object({
/** Master account address associated with the sub-account. */
master: v.pipe(_schemas_js_1.Address, v.description("Master account address associated with the sub-account.")),
}), v.description("Details for sub-account role.")),
}),
]), v.description("User role."));
})();
/**
* 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
*/
function userRole(config, params, signal) {
const request = v.parse(exports.UserRoleRequest, {
type: "userRole",
...params,
});
return config.transport.request("info", request, signal);
}
//# sourceMappingURL=userRole.js.map