@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
115 lines • 5.78 kB
JavaScript
"use strict";
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.PerpDexsResponse = exports.PerpDexsRequest = void 0;
exports.perpDexs = perpDexs;
const v = __importStar(require("valibot"));
// ============================================================
// API Schemas
// ============================================================
const _schemas_js_1 = require("../../_schemas.js");
/**
* Request all perpetual dexs.
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
*/
exports.PerpDexsRequest = (() => {
return v.pipe(v.object({
/** Type of request. */
type: v.pipe(v.literal("perpDexs"), v.description("Type of request.")),
}), v.description("Request all perpetual dexs."));
})();
/**
* Array of perpetual dexes (null is main dex).
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
*/
exports.PerpDexsResponse = (() => {
return v.pipe(v.array(v.nullable(
/** Perpetual dex metadata. */
v.pipe(v.object({
/** Short name of the perpetual dex. */
name: v.pipe(v.string(), v.description("Short name of the perpetual dex.")),
/** Complete name of the perpetual dex. */
fullName: v.pipe(v.string(), v.description("Complete name of the perpetual dex.")),
/** Hex address of the dex deployer. */
deployer: v.pipe(_schemas_js_1.Address, v.description("Hex address of the dex deployer.")),
/** Hex address of the oracle updater, or null if not available. */
oracleUpdater: v.pipe(v.nullable(_schemas_js_1.Address), v.description("Hex address of the oracle updater, or null if not available.")),
/** Hex address of the fee recipient, or null if not available. */
feeRecipient: v.pipe(v.nullable(_schemas_js_1.Address), v.description("Hex address of the fee recipient, or null if not available.")),
/** Mapping of asset names to their streaming open interest caps. */
assetToStreamingOiCap: v.pipe(v.array(v.tuple([v.string(), v.string()])), v.description("Mapping of asset names to their streaming open interest caps.")),
/** List of delegated function names and their authorized executor addresses. */
subDeployers: v.pipe(v.array(v.tuple([
v.string(),
v.array(_schemas_js_1.Address),
])), v.description("List of delegated function names and their authorized executor addresses.")),
/** Fee scale applied to deployer fees. */
deployerFeeScale: v.pipe(_schemas_js_1.UnsignedDecimal, v.description("Fee scale applied to deployer fees.")),
/** ISO 8601 timestamp (without timezone) of the last deployer fee scale change. */
lastDeployerFeeScaleChangeTime: v.pipe(_schemas_js_1.ISO8601WithoutTimezone, v.description("ISO 8601 timestamp (without timezone) of the last deployer fee scale change.")),
/** Array of tuples mapping asset names to their funding multipliers. */
assetToFundingMultiplier: v.pipe(v.array(v.tuple([v.string(), v.string()])), v.description("Array of tuples mapping asset names to their funding multipliers.")),
}), v.description(" Perpetual dex metadata.")))), v.description("Array of perpetual dexes (null is main dex)."));
})();
/**
* Request all perpetual dexs.
*
* @param config - General configuration for Info API requests.
* @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
*
* @returns Array of perpetual dexes (null is main dex).
*
* @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 { perpDexs } from "@nktkas/hyperliquid/api/info";
*
* const transport = new HttpTransport(); // or `WebSocketTransport`
*
* const data = await perpDexs({ transport });
* ```
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-all-perpetual-dexs
*/
function perpDexs(config, signal) {
const request = v.parse(exports.PerpDexsRequest, {
type: "perpDexs",
});
return config.transport.request("info", request, signal);
}
//# sourceMappingURL=perpDexs.js.map